diff mbox series

[8/8] standards.md: add note about document tags

Message ID 20261028-tags-v1-8-d5ad01019eae@bootlin.com
State New
Headers show
Series Add support for documentation tags | expand

Commit Message

Antonin Godard Oct. 28, 2026, 8:05 a.m. UTC 
Add a note on adding tags to new documents.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/standards.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
diff mbox series

Patch

diff --git a/documentation/standards.md b/documentation/standards.md
index 30d48a5bb..64b4cf13c 100644
--- a/documentation/standards.md
+++ b/documentation/standards.md
@@ -137,6 +137,21 @@  Note that only "absolute" paths (starting with a '/') are allowed. The root
 directory of that path is documentation/, that is, :doc:`/bsp-manual/index`
 points at documentation/bsp-manual/index.rst.
 
+## Tagging new sections
+
+When adding a new document, consider adding one or more tags at the bottom of
+the file with the following format:
+
+```rst
+.. only:: splithtml
+
+   .. tags:: <tag1>, <tag2>, ...
+```
+
+When adding tags, try to use one of the existing tags (see
+https://docs.yoctoproject.org/_tags/tagsindex.html#tagoverview), unless none of
+these fit for the document being added.
+
 ## Adding screenshots
 
 The preferred format for adding screenshots is