summaryrefslogtreecommitdiffstats
path: root/documentation/standards.md
Commit message (Collapse)AuthorAgeFilesLines
* manuals: standards.md5: add standard for project namesMichael Opdenacker2024-04-241-15/+18
| | | | | | | | | | | | | | | | Set a new standard to introduce project names with single quotes, so that they appear in generated text with an italic font, to make them easier to distinguish from command names and from ordinary English words. Rework and move the standard for command and file names to make the whole description "flow" better. (From yocto-docs rev: fa6700af56213a5079eaa8d9683f3c2b2fc93740) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> CC: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: add initial stylechecks with ValeMichael Opdenacker2024-03-191-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: d145e1dc45dc0792c8b8f7e73500b56face1e710) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc: standard for bulleted listsMichael Opdenacker2022-06-211-0/+25
| | | | | | | (From yocto-docs rev: 78bfe970529efeb93493407cedeb03056ade2bd2) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* docs: standards.md: add more rules: line wrapping and variablesMichael Opdenacker2022-06-211-4/+39
| | | | | | | | | Fix Markdown syntax too (From yocto-docs rev: f836a2fbe401865d3e9af691d71de97e9c5df70a) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: improve the width of diagramsMichael Opdenacker2022-05-101-2/+8
| | | | | | | | | | | | Better for EPUB output in particular - Make some diagrams wider when necessary - Remove ":align: center" when we have ":width: 100%" - Update the standards.md files to mention this (From yocto-docs rev: 848ba7bd8984cc3f4bf6b818259865011cde0476) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* doc: standards for project and file namesMichael Opdenacker2022-05-101-1/+23
| | | | | | | (From yocto-docs rev: 4e658b0f9552462e9168d8598314ed4ddeee7692) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>