kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2026-01-01 01:41:18 +01:00
Code Releases Activity

doc: move pages to starlight and deprecate in doxygen

Browse Source
This commit is contained in:
Lasse Rosenow 2025-09-22 13:09:06 +02:00
parent 05f533a2a9
commit 996f97c134
No known key found for this signature in database
11 changed files with 60 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
GOVERNANCE.md
View File

@ -259,7 +259,7 @@ Computing Foundation (CNCF).
[maintainers GitHub team]: https://github.com/orgs/RIOT-OS/teams/maintainers
[managing a release]: https://github.com/RIOT-OS/RIOT/blob/master/doc/guides/managing-a-release/README.md
[maintaining guidelines]: https://github.com/RIOT-OS/RIOT/blob/master/MAINTAINING.md
[Code of Conduct]: https://github.com/RIOT-OS/RIOT/blob/master/CODE_OF_CONDUCT.md
[Code of Conduct reporting guidance]: https://doc.riot-os.org/coc-reporting-guide.html
[Code of Conduct]: https://guide.riot-os.org/general/code_of_conduct/
[Code of Conduct reporting guidance]: https://guide.riot-os.org/general/code_of_conduct/reporting/
[security policy]: https://github.com/RIOT-OS/RIOT/blob/master/SECURITY.md
[GOVERNANCE-maintainer.md template]: https://github.com/cncf/project-template/blob/main/GOVERNANCE-maintainer.md

6
doc/doxygen/riot.doxyfile
View File

@ -866,10 +866,10 @@ INPUT = ../../doc.txt \
src/ \
src/mainpage.md \
src/vision.md \
src/governance.md \
src/governance-deprecated.md \
src/roadmap.md \
src/coc-info.md \
src/coc.md \
src/coc-deprecated.md \
src/coc-reporting-guide.md \
src/coc-faq.md \
src/creating-modules.md \
@ -893,7 +893,7 @@ INPUT = ../../doc.txt \
src/release-cycle.md \
src/io-mapping-and-shields.md \
src/changelog.md \
../../LOSTANDFOUND.md \
src/LOSTANDFOUND.md \
../../makefiles/pseudomodules.inc.mk \
../../makefiles/blob.inc.mk \
../../sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c \

5
doc/doxygen/src/LOSTANDFOUND.md Normal file
View File

@ -0,0 +1,5 @@
Removed Features and Modules (Deprecated) {#md_LOSTANDFOUND}
============================
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/misc/lost_and_found/).
This page will be removed after release 2026.04.

5
doc/doxygen/src/coc-deprecated.md Normal file
View File

@ -0,0 +1,5 @@
Code of Conduct (Deprecated) {#coc-deprecated}
===============
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/).
This page will be removed after release 2026.04.

5
doc/doxygen/src/governance-deprecated.md Normal file
View File

@ -0,0 +1,5 @@
Governance of the RIOT Community (Deprecated) {#governance}
================================
@deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/governance/).
This page will be removed after release 2026.04.

0
doc/guides/c_tutorials/using_cpp.md → doc/guides/cpp_tutorials/using_cpp.md
View File

17
doc/starlight/Makefile
View File

@ -23,7 +23,7 @@ clean:
-@rm -rf node_modules .astro dist
.PHONY: integrate_outside_files
integrate_outside_files: code_of_conduct governance
integrate_outside_files: code_of_conduct governance lostandfound coding_conventions coding_conventions_cpp
.PHONY: code_of_conduct
code_of_conduct: ../../CODE_OF_CONDUCT.md
@ -35,3 +35,18 @@ code_of_conduct: ../../CODE_OF_CONDUCT.md
governance: ../../GOVERNANCE.md
-@echo "Generating Governance documentation..."
-@sed '1,2d' $< | sed '/<!-- TOC start -->/,/<!-- TOC end -->/d' | cat ./templates/GOVERNANCE.template.md - > ../guides/generated/GOVERNANCE.md
.PHONY: lostandfound
lostandfound: ../../LOSTANDFOUND.md
-@echo "Generating Lost and Found documentation..."
-@sed '1,2d' $< | cat ./templates/LOSTANDFOUND.template.md - > ../guides/generated/LOSTANDFOUND.md
.PHONY: coding_conventions
coding_conventions: ../../CODING_CONVENTIONS.md
-@echo "Generating Lost and Found documentation..."
-@sed '1,2d' $< | cat ./templates/CODING_CONVENTIONS.template.md - > ../guides/generated/CODING_CONVENTIONS.md
.PHONY: coding_conventions_cpp
coding_conventions_cpp: ../../CODING_CONVENTIONS_C++.md
-@echo "Generating Lost and Found documentation..."
-@sed '1,2d' $< | cat ./templates/CODING_CONVENTIONS_CPP.template.md - > ../guides/generated/CODING_CONVENTIONS_CPP.md

10
doc/starlight/astro.config.mjs
View File

@ -96,7 +96,14 @@ export default defineConfig({
"c_tutorials/threads",
"c_tutorials/gpio",
"c_tutorials/saul",
"c_tutorials/using_cpp",
"c_tutorials/coding_conventions",
],
},
{
label: "C++ Basics",
items: [
"cpp_tutorials/using_cpp",
"cpp_tutorials/coding_conventions",
],
},
{
@ -135,6 +142,7 @@ export default defineConfig({
"misc/dev_best_practices",
"misc/io_mapping_and_shields",
"misc/roadmap",
"misc/lost_and_found",
"misc/release_cycle",
"misc/managing-a-release",
"misc/emulators",

5
doc/starlight/templates/CODING_CONVENTIONS.template.md Normal file
View File

@ -0,0 +1,5 @@
---
title: Coding Conventions
description: This document outlines the coding conventions of RIOT.
slug: c_tutorials/coding_conventions
---

5
doc/starlight/templates/CODING_CONVENTIONS_CPP.template.md Normal file
View File

@ -0,0 +1,5 @@
---
title: Coding Conventions C++
description: This document outlines the C++ coding conventions of RIOT.
slug: cpp_tutorials/coding_conventions
---

5
doc/starlight/templates/LOSTANDFOUND.template.md Normal file
View File

@ -0,0 +1,5 @@
---
title: Removed Features and Modules
description: This document contains a listing of all features and modules that were removed from RIOT at some point in time.
slug: misc/lost_and_found
---