paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 25 Packages Projects Releases Wiki Activity

style: use numbered lists (#34057)

Browse Source 
* style: use numbered lists

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

* Update docs/contribute/doc-style-guide.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>

* fix prettier

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
Aramis Sennyey
2026-04-27 16:38:56 -04:00
committed by GitHub
parent 50c324e617
commit ffae2d437c
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/contribute/doc-style-guide.md
+8
View File
@@ -228,6 +228,14 @@ helps downstream localization.
- Use (`-`) for unordered lists.
- Leave a blank line after each list.
- Indent nested lists with two spaces.
- Use a numbered list for a sequence of steps rather than prose with
"First", "Then", and "Finally". Numbered lists are easier to scan, make
the order explicit, and give readers a clear way to reference a specific
step.
| Do | Don't |
| :----------------------------------------------------------------- | :------------------------------------------------------------------------------ |
| 1) Install the package. 2) Run the migration. 3) Start the server. | First, install the package. Then, run the migration. Finally, start the server. |
### Tables