The layout of the Chinese and English HTML docs seems inconsistent, with the English ones at /html and the Chinese ones at /docs/zh/html. Additionally, having a folder called docs inside a repository explicitly for documentation seems redundant.
Here's my proposal for a directory structure:
sdk: HTML/Sphinx documentation from the original SDK
zh: Original Chinese
source: Sphinx source
html: Rendered HTML
en: English translation
source: Sphinx source
html: Rendered HTML
mirrored: Files available elsewhere online that we want to preserve, such as BL602_BL604_DS_Datasheet.pdf
reverse_engineered: Docs written by community members, such as my hardware_notes.md
README.md: Top-level docs README describing this directory structure, how to contribute, and related repos.
The layout of the Chinese and English HTML docs seems inconsistent, with the English ones at
/html
and the Chinese ones at/docs/zh/html
. Additionally, having a folder calleddocs
inside a repository explicitly for documentation seems redundant.Here's my proposal for a directory structure:
sdk
: HTML/Sphinx documentation from the original SDKzh
: Original Chinesesource
: Sphinx sourcehtml
: Rendered HTMLen
: English translationsource
: Sphinx sourcehtml
: Rendered HTMLmirrored
: Files available elsewhere online that we want to preserve, such asBL602_BL604_DS_Datasheet.pdf
reverse_engineered
: Docs written by community members, such as myhardware_notes.md
README.md
: Top-level docs README describing this directory structure, how to contribute, and related repos.Thoughts?