-
Notifications
You must be signed in to change notification settings - Fork 55
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
docs: make landing pages more informative #524
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, this is very good -- just requesting a few nit comments/changes.
In addition, I think we should discuss the ToC order. I think the "natural" or "logical" order is good in the main document, but (especially as things get longer) alphabetical order would be better for scanning/finding things in the ToC on the left. But let's discuss at/after daily.
Thanks @benhoyt! I've included your suggestions in dwilding@e90e04e Let's discuss the TOC approach today |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, thanks. Feel free to merge as is and figure out the ToC ordering in a separate PR, or include that in this one -- doesn't matter to me either way.
@benhoyt, @IronCore864 I've reorganized the links after our discussion. Changes in 261e6da:
Let me know if you think anything should be changed! |
The purpose of this PR is to use a consistent style for the three landing pages How-to guides, Explanation, and Reference. How-to guides already has the style we want, so I'm using the same style for Explanation and Reference.
Summary of changes: