search

mrf7777 / Modular-OS-Toolchain

This toolchain makes development for Modular OS easy by providing platform-independent Python tools.
GNU General Public License v3.0
0 stars 0 forks source link

Future of Documentation #16

Open mrf7777 opened 3 years ago

mrf7777 commented 3 years ago

Should the documentation for the toolchain and Modular OS be located in a docs subdirectory, a GitHub wiki, or a GitHub Pages repository?

mrf7777 commented 3 years ago

https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis

This says that pages are indexed and can be found with a search engine. Also, wikis are not indexed; this would makes pages better for making documentation easier to reach. After all, the users of Modular OS are most likely going to want to know how to develop for it and use it; so the pages should hold usage and developers information.