[FIX] Unify section titles and table-of-contents entries #422
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
chrisgorgo
previously approved these changes
Feb 20, 2020
sappelhoff
previously approved these changes
Feb 20, 2020
There was a problem hiding this comment.
I think this is a reasonable suggestion and the implementation does not seem to produce any rendering errors (e.g., links seem to work according to link checker and a quick inspection).
One additional (unrelated) request: Could you edit this file:
So that it say: 0/site/01-introduction.html, please?
I have noticed that the current link is wrong. See:
- Broken: https://1801-150465237-gh.circle-artifacts.com/0/home/circleci/project/site/01-introduction.html
- Fixed: https://1801-150465237-gh.circle-artifacts.com/0/site/01-introduction.html
This change will then allow you to click on the "build_docs artifact" CHECK and immediately see the built spec.
Done @sappelhoff ! |
sappelhoff
approved these changes
Feb 20, 2020
effigies
approved these changes
Feb 24, 2020
effigies
changed the title
franklin-feingold
approved these changes
Feb 25, 2020
|
Thanks @nicholst |
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.
Work on #400 revealed that there were inconsistencies between the mkdocs navigation titles and the section titles in the markdown files, a difference that becomes more evident when only a rendered PDF is examined and compared to the HTML version.
These changes mainly comprise dropping some terms, removing unneeded hypens and removing abbreviations. The abbreviations, so removed, then do need to be moved into the first line of the corresponding section.
See also #421 that discusses this issue.