style-guide: organize content and update sections; *: fix Markdownlint errors (#12148)

* style-guide: organize content and add contents section

* style-guide: fix general writing section title

* style-guide: fix heading level of help and version commands

* style-guide: fix heading level of see also section

* cleanup: update files

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* contributing: fix page for markdown lint

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* fix: markdownlint errors across files

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* docs: improve documentation about keycaps

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* docs: add info about optional and string placeholders

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* cleanup: sync changes with recent versions of style guide

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>

* cleanup: update style guide

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

* docs: update style guide

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

* docs/style-guide: reword more info links section

Co-authored-by: Vítor Henrique <87824454+vitorhcl@users.noreply.github.com>

---------

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
This commit is contained in:
Vítor Henrique
2024-04-22 00:50:17 -03:00
committed by GitHub
parent ff25dcff9a
commit 5e6dc70b2c
9 changed files with 261 additions and 184 deletions

View File

@@ -220,7 +220,9 @@ can then perform the actual role changes.
## CODEOWNERS
The [`.github/CODEOWNERS` file](https://github.com/tldr-pages/tldr/blob/main/.github/CODEOWNERS) allows contributors with write access to the [tldr-pages/tldr repository](https://github.com/tldr-pages/tldr) to get automatic review request notifications for given files and directories.
The [`.github/CODEOWNERS` file](https://github.com/tldr-pages/tldr/blob/main/.github/CODEOWNERS) allows contributors with write access to the [tldr-pages/tldr repository](https://github.com/tldr-pages/tldr)
to get automatic review request notifications for given files and directories.
If they wish to, contributors can open a pull request to add themselves to this file as desired.
Example uses include (but are not limited to):