linux/poky.git/documentation/standards.md, branch 5.2_M1

standards.md: add a section on admonitions

2024-11-22T16:56:03+00:00

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 Reviewed-by: Quentin Schulz (From yocto-docs rev: 0c1252b67e602ebf7197e1388dd1fb86b37d25c8) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie

manuals: standards.md5: add standard for project names

2024-04-24T13:22:55+00:00

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 CC: Quentin Schulz Signed-off-by: Richard Purdie

manuals: add initial stylechecks with Vale

2024-03-19T15:22:27+00:00

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 Suggested-by: Thomas Petazzoni Signed-off-by: Richard Purdie

doc: standard for bulleted lists

2022-06-21T19:57:17+00:00

(From yocto-docs rev: 78bfe970529efeb93493407cedeb03056ade2bd2) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

docs: standards.md: add more rules: line wrapping and variables

2022-06-21T19:57:16+00:00

Fix Markdown syntax too (From yocto-docs rev: f836a2fbe401865d3e9af691d71de97e9c5df70a) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: improve the width of diagrams

2022-05-10T11:52:35+00:00

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 Signed-off-by: Richard Purdie

doc: standards for project and file names

2022-05-10T11:52:35+00:00

(From yocto-docs rev: 4e658b0f9552462e9168d8598314ed4ddeee7692) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie

manuals: start of documentation standards document

2021-11-07T10:44:52+00:00

This first version specifies how to create consistent SGV graphics (From yocto-docs rev: 370b9e34e9092c9eed22df2e8b2d0bb979487e5c) Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie