diff options
author | Evan Read <eread@gitlab.com> | 2019-03-14 10:57:40 +0000 |
---|---|---|
committer | Marcia Ramos <marcia@gitlab.com> | 2019-03-14 10:57:40 +0000 |
commit | 1cfe83ea5eb0c06b1922c474aecde7f78f2a3763 (patch) | |
tree | b32cee4ab8bf80fad039e0383f7181d2cf45907c /doc | |
parent | 516987e4ba40bffa68a1060efd901af2f1e6a3c3 (diff) | |
download | gitlab-ce-1cfe83ea5eb0c06b1922c474aecde7f78f2a3763.tar.gz |
Change line length recommendation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/documentation/styleguide.md | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 0c51d3832aa..c0386290785 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -80,11 +80,10 @@ yield a useful result, and ensuring content is helpful and easy to consume. ## Text -- Split up long lines (wrap text), this makes it much easier to review and edit. Only - double line breaks are shown as a full line break by creating new paragraphs. - 80-100 characters is the recommended line length. +- Splitting long lines (preferably up to 100 characters) can make it easier to provide feedback on small chunks of text. +- Insert an empty line for new paragraphs. - Use sentence case for titles, headings, labels, menu items, and buttons. -- Jump a line between different markups (e.g., after every paragraph, header, list, etc). Example: +- Insert an empty line between different markups (e.g., after every paragraph, header, list, etc). Example: ```md ## Header |