docs, mkdocs: fix domain, title caps #15
Merged
Conversation
This file contains 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
Signed-off-by: William Woodruff <william@trailofbits.com>
|
(NB: I've also made an effort to retain the same |
miketheman
approved these changes
Jul 2, 2024
There was a problem hiding this comment.
I'm generally fine with this - as it does make it explicit and allows us to control the order.
@ewdurbin any objections?
| # Terms of use | ||
| # Terms of Use |
There was a problem hiding this comment.
Note: if the case here changes, we'll need an update over here:
https://github.com/pypi/warehouse/blob/83b0c6de32c174208f3a65c061bd8fcc8983213c/warehouse/routes.py#L62
(and associated test case) as mkdocs/rtd are case sensitive.
There was a problem hiding this comment.
Cool, I'll make a PR there as well!
miketheman
reviewed
Jul 2, 2024
Signed-off-by: William Woodruff <william@trailofbits.com>
|
maybe add a note to README "how to add a page to nav"? |
Signed-off-by: William Woodruff <william@trailofbits.com>
Done with 934e64e! |
ewdurbin
approved these changes
Jul 2, 2024
miketheman
approved these changes
Jul 2, 2024
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.
Fixes the sentence-casing of domains (and some small title inconsistencies) by adding an explicit
navhierarchy.Downside: requires files to be tracked in the
navhierarchy as well before they get rendered. This downside is shared by the PyPI user + dev docs currently, and is a known limitation of mkdocs.Before:
After:
CC @miketheman, who made me see these and activated my compulsion to fix them 🙂