Link the API reference from the README and back again - #35
Merged
Conversation
The reference was only reachable by typing /api/ onto the project page. The README - which is that page - now carries a badge and a line under it, and its API reference section leads with the published URL rather than with instructions for building a local copy. The reference had no way back either. Its main page now links to the project page, the repository and the samples, and points at "Topics" rather than "Modules", which is what the tab has been called since Doxygen 1.10. Co-Authored-By: Claude Opus 5 (1M context) <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
1 participant
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.
The reference was only reachable by typing
/api/onto the project page.README → reference
The README is the landing page, so it now carries a badge in the existing row and a line right under it:
Its
## API referencesection now leads with the published URL instead of with instructions for building a local copy; the local build is still there, below.Reference → back
The reference had no way back at all. Its main page now links to the project page, the repository and the samples.
It also told readers to use the Modules list, which has been called Topics since Doxygen 1.10 — so the one navigation hint it gave named a tab that does not exist. Fixed, and it now also mentions Data Structures and the search box.
Verification
index.htmlMerging this triggers a Docs deployment, so the links go live with it.
🤖 Generated with Claude Code