Skip to content

Documentation fixes#1257

Open
kikeprime wants to merge 8 commits intoOpenKH:masterfrom
kikeprime:master
Open

Documentation fixes#1257
kikeprime wants to merge 8 commits intoOpenKH:masterfrom
kikeprime:master

Conversation

@kikeprime
Copy link
Copy Markdown
Contributor

@kikeprime kikeprime commented Apr 13, 2026

I fixed the broken tables for the KH1 and KH2 docs of the website. I also fixed numerous typos in the various files too.
I added the wpn dictionary to the KH1 index.
I fixed the broken image links for docs/kh2/icons.md.

Summary by CodeRabbit

  • Bug Fixes

    • Corrected spell and item names in game dictionaries for accuracy
    • Fixed world naming inconsistencies (e.g., "Destiny Islands", "Halloween Town", "Dive to the Heart")
  • Documentation

    • Enhanced navigation with clearer and more descriptive category labels
    • Improved table formatting consistency across game guides
    • Updated asset reference paths in documentation files

This is the start of my series of commits to update the KH1 docs a bit.
The 2nd and 3rd tier spell commands.
Megalixir
I mostly fixed incorrect names. For consistency with the command dictionary I used the standard English names for the 4 KH1 Limits.
Unlike GitHub, the website needs a blank line before tables to render them.
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 13, 2026

Warning

Rate limit exceeded

@kikeprime has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 47 minutes and 14 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 47 minutes and 14 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5d615563-4945-4e4e-961d-1be618c7c0de

📥 Commits

Reviewing files that changed from the base of the PR and between e71bc2c and 3afc74a.

📒 Files selected for processing (1)
  • docs/kh1/worlds.md
📝 Walkthrough

Walkthrough

Documentation updates across KH1 and KH2 game files: formatting improvements with added blank lines, corrected world/item names, reorganized icon paths into subdirectories, and updated command/inventory mappings for consistency.

Changes

Cohort / File(s) Summary
KH1 Navigation & Formatting
docs/kh1/index.md, docs/kh1/dictionary/wpn.md, docs/kh1/worlds.md
Added descriptive category links for MDLS and WPN files; inserted blank lines after section headings; corrected world names (Dive to HeartDive to the Heart, Destiny IslandDestiny Islands, HalloweentownHalloween Town); adjusted text spacing.
KH2 Dictionary Data Corrections
docs/kh2/dictionary/commands.md, docs/kh2/dictionary/inventory.md
Updated spell/magic command mappings to higher-tier forms; corrected item names (MegaelixirMegalixir, Anti-FormAntiform, Way of DawnWay to the Dawn); fixed ability/attack names; ensured files end with newlines.
KH2 Asset Path Reorganization
docs/kh2/dictionary/icons.md
Reorganized icon image paths into categorized subdirectories (misc/, original/) under ../../kh2/images/icons/ for all referenced icon IDs.
Documentation Structure
docs/kh2/unused.md
Added blank line after section heading for consistent formatting.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Blank lines hop through docs so neat,
Item names spell-corrected, sweet!
World names polished, paths rearranged,
A dictionary garden, beautifully changed! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Documentation fixes' directly addresses the main objective of the PR, which involves correcting and fixing various documentation files across KH1 and KH2.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/kh1/worlds.md`:
- Around line 8-14: The table rows for world codes (e.g., "DH | Dive to the
Heart", "DI | Destiny Islands", "EW | End of the World", "GB | Unknown", "HE |
Olympus Coliseum", "LM | Atlantica", "NM | Halloween Town") use leading-only
pipes; update each row to include a trailing pipe as well so every row is framed
with both leading-and-trailing pipes (fix the MD055 lint warning).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: ba079676-8bcd-4aad-8546-c2378ecfdbd5

📥 Commits

Reviewing files that changed from the base of the PR and between 96a032b and e71bc2c.

📒 Files selected for processing (7)
  • docs/kh1/dictionary/wpn.md
  • docs/kh1/index.md
  • docs/kh1/worlds.md
  • docs/kh2/dictionary/commands.md
  • docs/kh2/dictionary/icons.md
  • docs/kh2/dictionary/inventory.md
  • docs/kh2/unused.md

Comment thread docs/kh1/worlds.md Outdated
This should be alright now.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant