Open marwan-at-work opened 5 years ago
I think it's a good idea to think this through - maybe we could make a small list of projects with great docs + some description of what makes it so good. Something like:
We could then compile a list of features we think are important with examples.
We should do the same for #922
We should probably include the reference from #921 into our new docs setup too
@marwan-at-work thank you for opening this 💯 🎉 I put my opinions on your questions below
Should we make our docs just one single page, with a navigator on the side? What should the sections look like?
I feel like we should have these:
config.toml
like what you brought up Can we make sure that everything is documented on the website and no one needs to go to github for external documentation (such as the config.toml file)
Let me know what you think?
@marpio here are some projects that have docs that stand out to me:
In the Dec 6 meeting, @manugupt1 suggested that we should try un-collapsing the sidebar of our site and seeing how much further that takes us
I obviously have #972 open, but I am also going to create a draft sitemap. I'll share a link to it in here when it's done
Our docs website is not well organized as of right now. I still struggle to find things I wrote myself because I'm not sure which section it belongs to.
We should holistically look at how to make our documentation an end-to-end journey. Something simple, understandable, and just great...I know I'm throwing jargon here, but I believe it's really worth it.
So before we just "code something", we should think about the experience itself. How should the experience of our docs website look like?
Questions to be answered: