Closed JoshCheek closed 7 years ago
I can take a hack at this too if you'd like.
I've done a lot of GitHub wiki work on my repos at my job. I know the exact problem you are talking about re: README vs wiki. GitHub Wikis aren't the most feature-rich, but it's the best we've found in terms of having docs being easy-to-update while maintaining multi-page structure/organization.
For now - we've settled on putting the bulk of the documentation in the wiki, and keeping REAME fairly broad.
Maybe some first steps would be for me to:
Just let me know.
That would super appreciated! I've not looked at the wiki repo at all, so IDK what is even possible. Meaning you have the authority to make whatever decisions cause these statements to be true:
Yup - sounds great.
I'll start tackling the sidebar 1st, and we can go from there!
To do
_[TOC]_
Ask Josh
Maybe Later
Ok @JoshCheek - the sidebar & TOC are built. Along with a modified Homepage.
I'll keep this issue open as my overall "todo list" while I start migrating issues over to wiki ( #110 )
Two ideas above in my todo list that I added. See if you like them:
wiki page for how to search wiki (was not intuitive to me how GH does this, constantly got ?s on it at work)
Up to you. What info might someone be looking for, will they need a search page to find it?
wiki page for curating related projects like Bret Victor stuff, Swift Playgrounds. I always felt the ruby community needed a good source like this, but have not found one
I'm in :)
Good deal - I added both.
Not really sure what to do with it, but the one on there makes it feel unloved. Perhaps clone it and see if there's a config file somewhere, probably the one on installation should be the default home page for the wiki.
Note that all the pages in the wiki are linked from the readme, so really the readme is behaving like the wiki homepage.