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

Slightly improve documentation navigation #13906

Merged
merged 1 commit into from
Feb 18, 2019
Merged

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Feb 17, 2019

Description

This PR tries to improve navigation in the documentation in two ways.

First, it adds a link to the tutorials on the first Handbook index page. If you do not know the tutorials exist it is tricky to find in the left navigation, so adding a link at the start helps for those looking to learn and jump in.

Secondly, it moves the automated documentation for data, packages, and components lower in the table of contents so it does not push down links that are likely more valuable when starting out. This gives a better hierarchy for the links to people learning towards the top, and the reference which likely someone will be looking specifically for towards the bottom.

There is investigation and efforts to improve the side navigation to be collapsible, which is the larger work to improve navigation, but this PR should help slightly.

Types of changes

Documentation.

@chrisvanpatten
Copy link
Member

I'm admittedly a little uncomfortable with this approach. It doesn't fundamentally fix the issue, and reverts a documentation structure that was arrived at through consultation with a number of stakeholders and docs team members.

That said, since I can't be more closely involved in the day-to-day of docs work at this point, I won't put up too big a fight. I think it's incredibly disappointing that we can't more easily control/improve our own documentation site, but that's a discussion for another day.

@mkaz
Copy link
Member Author

mkaz commented Feb 17, 2019

@chrisvanpatten yeh, its not an ideal setup, and I wasn't trying to subvert any past decision. I just noticed every time trying to navigate to the tutorials it's not easy. I thought moving them up would be better, especially for new developers browsing the handbook.

I'll break this into two PRs, with this first one just adding a link on the index page. I'll create a new PR leave the table of contents change to be discussed.

@gziolo
Copy link
Member

gziolo commented Feb 17, 2019

I personally fully agree that this is a good proposal to temporarily improve the discoverability of tutorials until the menu gets improved. How about we land it as is and change it back later when the way menu works is fixed? By thw way, I strongly believe that tutorials should be in their own section visibly highlighted in the handbook. It might be even linked in the header orvsth like that.

@mkaz
Copy link
Member Author

mkaz commented Feb 17, 2019

I strongly believe that tutorials should be in their own section visibly highlighted in the handbook

That was my initial thought too, moving them to the top level, but thought that might of been too much. I believe people learn best by trying the tutorials and then when they get stuck and or want to advance further then reading the deeper documentation.

Copy link
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

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

Good idea to include tutorials reference in here 💯

@gziolo gziolo merged commit 5dc9ac4 into master Feb 18, 2019
@gziolo gziolo deleted the docs/tutorial-links branch February 18, 2019 07:36
@youknowriad youknowriad added this to the 5.2 (Gutenberg) milestone Feb 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants