Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add previous/next links to documentation files #282

Merged
merged 6 commits into from
Aug 18, 2017

Conversation

randycoulman
Copy link
Contributor

This PR adds Previoius/Next links between the documentation files, making it easier to read the documentation end-to-end.

Along the way, I fixed a few inconsistencies and issues:

  • The TOC in the README was not nesting properly. It looks like GitHub requires the nested list number to be at the same indentation level as the text of the parent item, not just two spaces in.
  • The TOC in the README was linking to the second-level Background header in 2-howto-purpose instead of the top-level header.
  • The TOC in the README was only linking to the C-configuration page, not the top-level header.
  • 8-custom-matchers was using level 3/4 headers instead of level 1/2 like all of the other documents.

This gets more of the document on the page immediately, rather than
requiring scrolling past the top part of GitHub's UI.
All other docs use level 1 and level 2 headings.
It's not indenting the sub ordered lists
It looks like GitHub requires the nested list to be indented to the same
level as the text after the number.
@searls
Copy link
Member

searls commented Aug 18, 2017

Fantastic—thank you Randy!

@searls searls merged commit 83ebd6a into testdouble:master Aug 18, 2017
@randycoulman randycoulman deleted the add-links-between-docs branch August 18, 2017 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants