docs: link the generated API reference from the README - #21
Merged
Merged
Conversation
The API reference is now deployed to GitHub Pages, but nothing in the repo points at it. Adds a badge under the title and an entry in the Documentation section alongside the docs.shinro.xyz guides. Live: https://shinro-xyz.github.io/shinro-python-modules/ Also sets mkdocs site_url, which was unset — canonical URLs, the generated sitemap and search relevance all depend on it.
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
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.
What
The API reference is already deployed to GitHub Pages (PR #20, workflow run 34995467734 — success), but nothing in the repo points at it. This adds the link.
Live now: https://shinro-xyz.github.io/shinro-python-modules/
Changes
README.md— two additions:docs.shinro.xyzguides, describing what it covers and noting it's generated:mkdocs.yml— setssite_url, which was unset. Canonical URLs, the generated sitemap, and search relevance all depend on it.Placement note
I put this alongside the
docs.shinro.xyzlinks rather than replacing them — they're different things:docs.shinro.xyz— hand-written conceptual/operational guidesHappy to merge them onto one domain later, but that's a separate decision.
Verification
HTTP 200, titleHome - shinromainorigin/main(a50a2cb)Generated with Hermes Agent