Commit graph

17 commits

Author SHA1 Message Date
p-szafonimateusz
36aefeadfe Documentation: review supported POSIX interfaces in NuttX
Add a page in the documentation listing supported and unsupported POSIX options.
This is the first step to support POSIX Application Environment Profiles.

Signed-off-by: p-szafonimateusz <p-szafonimateusz@xiaomi.com>
2025-06-12 10:13:52 -03:00
Matteo Golin
4f652e0622 docs/tags: Introduce tagging feature to the documentation.
Introduces `sphinx-tags` to the documentation system, allowing
individual pages to be tagged for better searching. The examples in this
commit introduce the `chip:*` tag for indicating the chip a board uses,
as well as the `experimental` tag for indicating experimental boards and
features. Other tags indicate supported peripherals for boards, such as
`wifi` and `ethernet`.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2025-04-29 09:18:25 +02:00
raiden00pl
9394962cf6 Documentation: move debug pages to a separate top level page
Move debug related pages from Guides to a separate top level page.
This way all pages related to debugging will be in one place
which is more user friendly.

Related Github issue: https://github.com/apache/nuttx/issues/15667

Signed-off-by: raiden00pl <raiden00@railab.me>
2025-03-24 20:23:47 +08:00
Alan Carvalho de Assis
a5572d8281 Documentation: Add NuttX Logo page
This commit add a page where users can find the NuttX Logos in
PNG and SVG format.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2024-04-16 11:25:08 +08:00
raiden00pl
3b23a693ac Documentation: migrate "Linux Processes vs NuttX Tasks" from wiki
link: https://cwiki.apache.org/confluence/display/NUTTX/Linux+Processes+vs+NuttX+Tasks
2023-11-05 12:11:14 +08:00
raiden00pl
ce97fccf9a Documentation: split some long lines 2023-10-30 20:29:54 +08:00
Alan C. Assis
6031e06ff2 Move "Contributing" to be after getting started 2021-08-23 21:22:49 +08:00
Alan C. Assis
9d5ed6e594 Documentation: Add FAQ entry 2021-04-14 15:09:21 -03:00
Matias N
87596d74dd Documentation: introduce hardware platforms documentation 2021-02-07 08:38:51 -03:00
Matias N
d118249566 Documentation: remove empty releases section; put reference up higher 2020-11-21 18:09:19 -08:00
Matias N
31f77461b3 Documentation: reorder introduction in index 2020-11-21 18:09:19 -08:00
Xiang Xiao
8a7982bec0 Documentation: Change 32bit arch to 64bit arch
since NuttX support at least 64bit x86 and riscv now

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:46:20 -07:00
Xiang Xiao
55aff276ee Documentation: Reorder Documentation/index.rst
1.Move quickstart to first
2.Move boards after introduction
3.Move reference after guides

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 11:45:05 -07:00
Xiang Xiao
598e3eedb4 Documentation: Remove all tail spaces from *.rst and *.html
by the below command:
find . -type f -name '*.rst' -exec sed --in-place 's/[[:space:]]\+$//' {} \+

Signed-off-by: Xiang Xiao <xiaoxiang@xiaomi.com>
2020-10-18 10:51:22 -07:00
Adam Feuer
d655f47d13 convert INVIOLABLES.txt to markdown, add to docs 2020-08-25 16:03:42 -07:00
Matias N
4a38a15332 convert TODOs to actual TODO banner and improve general presentation of different sections 2020-08-24 10:29:55 -07:00
Matias N
4276d6254a rename doc/ -> Documentation/ 2020-08-24 10:29:55 -07:00
Renamed from doc/index.rst (Browse further)