search

whitecatboard / Lua-RTOS-ESP32

Lua RTOS for ESP32
Other
1.2k stars 221 forks source link

Feature request: make docs part of the main repository #380

Open chowette opened 3 years ago

chowette commented 3 years ago

Hi,

When making improvement to the source code, you always need to update the documentation accordingly. Today, the doc is in a wiki which is part of a separate repository.

It would be nice to host the docs directly in a /docs/ folder so the documentation change can be part of the PR and commit history.

This will also enable easy integration with other tools like mkdocs and readthedocs and continuous build using github actions

See Continuous Documentation: Hosting Read the Docs on GitHub Pages

You can still edit and preview .md files from github web interface like the wiki

What do you think?

the0ne commented 1 year ago

The disadvantage would be that the Wiki would no longer work, right? Can you create a PR to show how it could look?