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

docs: use accordions for common issues in golden-path (#33840)

Browse Source 
* fix: use accordions for common issues

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

* fix code block

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

---------

Signed-off-by: aramissennyeydd <aramis.sennyey@doordash.com>
This commit is contained in:
Aramis Sennyey
2026-04-13 10:23:44 -04:00
committed by GitHub
parent 68c557b381
commit 722b35e1a4
2 changed files with 54 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/contribute/doc-style-guide.md
+31
View File
@@ -157,6 +157,37 @@ dilute their impact and make the content harder to read. If a section has
more than two admonitions, restructure the content so that most of the
information is in regular paragraphs.
## Accordions
Use HTML `<details>` and `<summary>` elements to create collapsible sections.
These are useful for "Common issues" sections, lengthy reference tables, or
supplementary content that would otherwise break the reading flow.
```markdown
<details>
<summary>Summary text visible when collapsed</summary>
Content inside the accordion. You can use **Markdown** here, including code
blocks, lists, and other formatting.
</details>
```
<details>
<summary>Summary text visible when collapsed</summary>
Content inside the accordion. You can use **Markdown** here, including code
blocks, lists, and other formatting.
</details>
Leave a blank line after the `<summary>` tag and before the closing
`</details>` tag so that Markdown content inside renders correctly.
Use backticks for inline code inside `<summary>` elements instead of HTML
`<code>` tags. Backticks render correctly inside summary elements and keep
the source consistent with the rest of the Markdown content.
## Markdown elements
### Line breaks