Skip to content

Add mdbook-toc, markers, and documentation #1028

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jan 20, 2021
Merged

Add mdbook-toc, markers, and documentation #1028

merged 4 commits into from
Jan 20, 2021

Conversation

igaray
Copy link
Member

@igaray igaray commented Jan 17, 2021 •
edited
Loading

Closes #1014

  • Add the preprocessor configuration to book.toml
  • Add the preprocessor to the .travis.yml CI configuration.
  • Add the preprocessor dependency and usage to the instructions on how to contribute to the guide.
  • Identify sections in need of a TOC and add the marker

TBH, it surprised me how useful this is in some sections.

@igaray igaray changed the title Fixes 1014 Add mdbook-toc, markers, and documentation Fixes #1014 Add mdbook-toc, markers, and documentation Jan 17, 2021
@igaray igaray changed the title Fixes #1014 Add mdbook-toc, markers, and documentation Add mdbook-toc, markers, and documentation Jan 17, 2021
@jyn514 jyn514 added the S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content label Jan 17, 2021
@jyn514
Copy link
Member

jyn514 commented Jan 17, 2021

Can you post a screenshot of some of the TOCs?

@jyn514
Copy link
Member

jyn514 commented Jan 17, 2021

Also, it would be nice to split out the pure cleanups into another PR (or just a different commit) so it's easy to tell what changes are relevant.

@igaray
Copy link
Member Author

igaray commented Jan 17, 2021 •
edited
Loading

Screenshots:
Screen Shot 2021-01-17 at 18 28 24

Screen Shot 2021-01-17 at 18 28 41

Screen Shot 2021-01-17 at 18 28 47

Screen Shot 2021-01-17 at 18 28 54

Screen Shot 2021-01-17 at 18 29 02

@igaray
Copy link
Member Author

igaray commented Jan 17, 2021

Incoming force-push with the split into separate commits.

@igaray igaray force-pushed the 1014.add_mdbook_toc branch from 4bc7e40 to d3fdf75 Compare January 17, 2021 21:56
@igaray
Copy link
Member Author

igaray commented Jan 17, 2021

Split it into three commits, one with the config and CI changes, another adding the toc markers and heading level changes, and the third with whitespace and punctuation fixes.

jyn514
jyn514 approved these changes Jan 19, 2021
View reviewed changes
Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks amazing 🎉

@igaray igaray merged commit bee2fd5 into rust-lang:master Jan 20, 2021
@igaray igaray deleted the 1014.add_mdbook_toc branch January 20, 2021 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jyn514 jyn514 jyn514 approved these changes

Assignees
No one assigned
Labels
S-waiting-on-review Status: this PR is waiting for a reviewer to verify its content
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add mdbook-toc
2 participants
@igaray @jyn514