-
Notifications
You must be signed in to change notification settings - Fork 39
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 table of contents, amend level of a few headings #30
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.
@mattlub Thank you for this!
I think you're right in that some of this will come down to personal taste. Maybe a guideline of the number of bullets so we don't run the risk of the content guide requiring a ton of scrolling and no longer being useful?
For example, I don't think we need all the bullets in 'Why tachyons?' here. For me, a contents guide is about a super quick overview of what is included so that:
a) If I'm coming to it for the first time, I can get a glimpse of what I'll be learning and aid my understanding of whether it will be genuinely useful as well as calm my questioning mind that keeps trying to jump the gun
b) If I'm using it a reference, I can quickly jump to where I want without having to scroll or guess at words with Ctrl + F
Not a blocker though. Let's get this in and do a little user testing.
@nelsonic, I'm happy to merge this. Let me know if you want to cast your eye over it.
@@ -8,6 +8,39 @@ functional** and **fast User Interface/Experience** (UI/UX) | |||
with **minimal CSS** | |||
in **much less time**._ | |||
|
|||
<!-- START doctoc --> |
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.
Why will also test to see whether we need a title here. I thought we would but previewing it, actually looks fine!
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.
@mattlub this is way more organised! thanks! 🎉
Would be great to capture the process (steps) went through to make this TOC. 😉
Thanks again! 🏆
related #26
done using doctoc:
looks like this:

Could it be condensed even more?