docs: point README documentation links to the live site#32
Merged
Conversation
Now that the docs are deployed, the README links to https://rodcor.github.io/kimetsu/docs/* instead of repo-relative docs/*.md, so GitHub/npm/crates readers land on the rendered site. Raw-path link text cleaned up (e.g. 'docs/INSTALL.md' -> 'the install guide'); license files stay repo-relative. The sync script rewrites those absolute URLs back to internal slugs when generating the site's own intro page, so on-site navigation stays in-site (SPA) rather than full-reloading to absolute URLs. Build verified: links resolve to /kimetsu/docs/<slug>, zero broken links. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Now that the docs are deployed at https://rodcor.github.io/kimetsu/, the README links to the rendered site instead of repo-relative
docs/*.md, so GitHub / npm / crates.io readers land on the live docs.https://rodcor.github.io/kimetsu/docs/<slug>(How Kimetsu Works, Install, Local models, Remote, CHANGELOG).docs/INSTALL.md->the install guide, etc.). License files stay repo-relative.sync-docs.mjsrewrites those absolute URLs back to internal slugs for the site's own intro page, so on-site nav stays in-site (verified: links resolve to/kimetsu/docs/<slug>, zero broken links).🤖 Generated with Claude Code