Yocto Project Documentation
 help / color / mirror / Atom feed
From: Antonin Godard <antonin.godard@bootlin.com>
To: docs@lists.yoctoproject.org
Cc: Antonin Godard <antonin.godard@bootlin.com>,
	 Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Subject: [PATCH 8/8] standards.md: add note about document tags
Date: Wed, 28 Oct 2026 09:05:00 +0100	[thread overview]
Message-ID: <20261028-tags-v1-8-d5ad01019eae@bootlin.com> (raw)
In-Reply-To: <20261028-tags-v1-0-d5ad01019eae@bootlin.com>

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 --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

-- 
2.55.0


      parent reply	other threads:[~2026-10-28  8:05 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-10-28  8:04 [PATCH 0/8] Add support for documentation tags Antonin Godard
2026-10-28  8:04 ` [PATCH 1/8] Pipfile: update dependencies for sphinx-tags Antonin Godard
2026-10-28  8:04 ` [PATCH 2/8] tools/host_packages_scripts/pip3_docs.sh: update " Antonin Godard
2026-10-28  8:04 ` [PATCH 3/8] conf.py: enable the sphinx-tags extension Antonin Godard
2026-10-28  8:04 ` [PATCH 4/8] sphinx-static/theme_overrides.css: customize tags appearance Antonin Godard
2026-10-28  8:04 ` [PATCH 5/8] Makefile: use splithtml tag for html target Antonin Godard
2026-10-28  8:04 ` [PATCH 6/8] docs-wide: tag sections Antonin Godard
2026-10-28  8:04 ` [PATCH 7/8] index.rst: link to the tags overview page for splithtml Antonin Godard
2026-10-28  8:05 ` Antonin Godard [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261028-tags-v1-8-d5ad01019eae@bootlin.com \
    --to=antonin.godard@bootlin.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=thomas.petazzoni@bootlin.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox