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

add TOC to Joining a Project and other .md docs #22

Open
weedySeaDragon opened this issue Dec 19, 2016 · 2 comments
Open

add TOC to Joining a Project and other .md docs #22

weedySeaDragon opened this issue Dec 19, 2016 · 2 comments

Comments

@weedySeaDragon
Copy link
Contributor

Most people won't scroll down. :-( Sad, but true. They'll typically only read the first paragraph of what they see. And if someone is viewing a doc on a small screen, like a phone or tablet, they see even less.

Adding a Table of Contents (TOC) at the top will get more people to read sections that are later in the document -- that they would have only seen if they scrolled down.

I think this would be really valuable for novices, since they are typically looking for 'a way in,' and don't always know what it is they're looking for. A TOC can provide them with clues. ("Oh! That looks helpful. I'll click and read that section.")

Just add a few bullets for the main sections; nothing long or fancy.

Would be happy to do a PR for each .md document if that'd be helpful.

@tansaku
Copy link
Contributor

tansaku commented Feb 1, 2017

@weedySeaDragon shall we make a decision about this PR first? #24 that adds a TOC to the joining a project page ...

@weedySeaDragon
Copy link
Contributor Author

[Not sure which "this" is the 'this' you're referring to. But I don't think the order is important. They're all in 'continuous improvement' mode.]
#24 looks great

I have the time to go thru the other .md docs if you'd like. (And of course I can't help but think about writing a little task to do it automatically. But that's for another day.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants