search

tenbaht / sduino

An Arduino-like programming API for the STM8
http://tenbaht.github.io/sduino/
GNU Lesser General Public License v2.1
355 stars 217 forks source link

Decide on one place for the documenation #18

Closed tenbaht closed 7 years ago

tenbaht commented 7 years ago

I am still undecided about the right place for the documentation. So far it exists in three different places in three different editing stages. This mess is the urgent need of a clean up.

The project wiki is easy accessible and markdown works nicely, but it doesn't support any page hierarchy and there is no proper navigation element apart from the unordered page list on the side.

My personal Github pages supports the amazing MkDocs which I like much better than Jekyll because it is very much self-contained and doesn't pull in lots of dependencies on installation. But it is global to all projects - it would be nice to keep them separate.

Using the [gh-pages branch of the project repository]() sounds like the perfect solution. The build-in markdown rendering does not work properly for tables and there is no proper navigation structure within the auto generated pages, but it seems that it is possible to upload MkDocs generated files directly. Need to figure that out and merge all information into this.

tenbaht commented 7 years ago

All docs now on the project website, generated using mkdocs from the sources in docs/ in the master branch. Deleted the wiki, checked the links.