Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reorganize docs for dev-esp32 #3059

Open
marcelstoer opened this issue Mar 22, 2020 · 0 comments
Open

Reorganize docs for dev-esp32 #3059

marcelstoer opened this issue Mar 22, 2020 · 0 comments
Labels
documentation ESP32

Comments

@marcelstoer
Copy link
Member

Triggered by reading #2694 (comment) again.

Last year @galjonsfigur did a great job reorganizing docs into Lua and C modules (see https://github.com/nodemcu/nodemcu-firmware/blob/dev/mkdocs.yml#L44 ff).
Every Lua module folder has a README that points to the documentation and the respective Lua module documentation. See https://github.com/nodemcu/nodemcu-firmware/tree/dev/lua_modules/email for an example.

We need the same for dev-esp32.
@stale stale bot added the stale label Mar 19, 2021
@nodemcu nodemcu deleted a comment from stale bot Apr 15, 2021
@stale stale bot removed the stale label Apr 15, 2021
@stale stale bot added the stale label Apr 16, 2022
@nodemcu nodemcu deleted a comment from stale bot Apr 16, 2022
@stale stale bot removed the stale label Apr 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation ESP32
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@marcelstoer