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 octane] Break out the upgrade guide into individual pages #1096
Conversation
@pzuraq do you think this change proposal should go to https://github.com/ember-learn/guidemaker-ember-template? Also maybe a different proposal, one that allows three levels in the sidebar. |
Ideally we will not use the "octane" keyword in these. Links or their redirects live forever, so it would be good to keep these pages reusable. |
That’s actually why I put the octane keyword in each of them, so they wouldn’t accidentally overlap with future guides for future editions. These are guides targeted for a specific edition upgrade, so it makes some sense to namespace them. Happy to remove the keyword, but I think that could be an issue when we release the next edition after Octane and need a new cheat sheet, etc. |
We should wait to merge this until after #1104 and the file renaming. |
61675e2
to
e566c44
Compare
This has been updated with nesting! Ready for final review 😄 |
e566c44
to
92d8ae2
Compare
I also tested the tabbing behavior and it seems good. |
92d8ae2
to
fdb9b71
Compare
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.
Thank you, Chris! This is so much easier to read and I appreciate all the work you did around the edges to make this happen.
Breaks out the upgrade guide into individual pages, including one that hasn't yet been written on Modifiers (I'll be focusing on that next).
Since we can't have nested sections yet, and we don't want to make the Octane upgrade guide a top level section, I opted to put a dash-bullet character at the beginning of the page titles. This is much better for reading the navigation in my opinion:
But it does result in a bit of an awkward top level title on the page itself:
I'm also unsure what the a11y impact of this would be. Personally, I would take the slightly awkwardness of the page title for increased clarity in navigation for now, and focus on getting the ability to have nested navigation asap (it would also be good for the new tutorial), but am open to suggestions. cc @mansona, I would love to help add the nesting to
guidemaker
if you have any guidance on that