update docs, remove uses.rst, structure.rst. Refactor docs, use README.rst for docs index.rst

2024-12-27 17:14:03 +07:00
parent 29f226c2fb
commit de38e53271
10 changed files with 25 additions and 174 deletions
--- a/docs/contributing/code_of_conduct.rst
+++ b/docs/contributing/code_of_conduct.rst
@@ -1 +1 @@
-../../CODE_OF_CONDUCT.rst
+.. include:: ../../CODE_OF_CONDUCT.rst
--- a/docs/contributing/index.rst
+++ b/docs/contributing/index.rst
@@ -19,5 +19,4 @@ Index
   :maxdepth: 2

   code_of_conduct
-   structure
   porting
--- a/docs/contributing/structure.rst
+++ b/docs/contributing/structure.rst
@@ -1,59 +0,0 @@
-*********
-Structure
-*********
-
-Tree
-====
-
-::
-
-  .
-  ├── docs
-  ├── examples
-  ├── hw
-  │   ├── bsp
-  │   └── mcu
-  ├── lib
-  ├── src
-  ├── test
-  └── tools
-
-docs
----
-
-Documentation
-
-examples
--------
-
-Sample with Makefile build support
-
-hw/bsp
------
-
-Supported boards source files
-
-hw/mcu
------
-
-Low level mcu core & peripheral drivers
-
-lib
---
-
-Sources from 3rd party such as freeRTOS, fatfs ...
-
-src
---
-
-All sources files for TinyUSB stack itself.
-
-test
----
-
-Unit tests for the stack
-
-tools
-----
-
-Files used internally