summaryrefslogtreecommitdiffstats
path: root/documentation/standards.md
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Fix typo in standards.mdSimon A. Eugster2025-02-151-1/+1
| | | | | | | | | | (From yocto-docs rev: cdcc30d9afad319c1a073a3bdffd439b6cd999c7) Signed-off-by: "Simon A. Eugster" <simon.eu@gmail.com> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit e6745669cc26de8f61d5d1ccdd5a95b552eece97) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* standards.md: add a section on admonitionsAntonin Godard2024-12-091-0/+15
| | | | | | | | | | | | | | | We try to limit our usage of these admonitions to `note` and `warning`, as the Sphinx documentation warns that most themes only style these two admonitions. So add a section on that. Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: 41788e6d230cfb49fadae58ab9651d57cc26f857) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit f86ffa1b1dcf0665c17424eee87b6bead09960f6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* documentation: standards.md: align with master branchMichael Opdenacker2024-05-151-3/+94
| | | | | | | (From yocto-docs rev: ecc1731d6bd2f3bce40010bbfa3b608dcf25dd04) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: add initial stylechecks with ValeMichael Opdenacker2024-04-051-0/+15
| | | | | | | | | | | | | Use the "Vale" (https://vale.sh) tool to perform text style checks Run "make stylecheck" to run the checks. This just checks the text, not the Sphinx syntax style choices. (From yocto-docs rev: e3e4ba2aa963d4d178c4e9e842e66f4ee4bd3736) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
* manuals: start of documentation standards documentMichael Opdenacker2021-11-071-0/+103
This first version specifies how to create consistent SGV graphics (From yocto-docs rev: 370b9e34e9092c9eed22df2e8b2d0bb979487e5c) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>