loading...

Discussion on: Explain like I'm five documentation

Collapse
nestedsoftware profile image
Nested Software

I think that many open source projects are small/simple enough that the readme file is sufficient to show people how to install and use the project.

For larger libraries and frameworks (think of things like react, webpack, python, etc), more comprehensive documentation becomes necessary. The link you provided is a project that helps to generate and organize the documentation for such larger open source projects. I have not used docusaurus, but the basic idea looks somewhat similar to github.com/readthedocs/readthedocs... (unlike readthedocs, docusaurus does not seem to offer hosting for the documentation; instead it can publish to github pages and other targets).

I am guessing that the documentation for the docusaurus project is generated by docusaurus :)