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

* 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
+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
@@ -88,12 +88,26 @@ yarn workspace @internal/plugin-todo start
## Common issues
- **Plugin page not showing up.** Verify that `app.packages` is set to `all`
in your `app-config.yaml`. If you use include/exclude filters, make sure your
plugin package is not excluded.
- **`yarn new --select frontend-plugin --option pluginId=todo --option owner=` fails during installation.** Make sure
you have run `yarn install` in the repository root first and that your
Node.js version matches the one required by the project.
- **TypeScript errors after scaffolding.** Run `yarn tsc` from the repository
root to check for type errors. A fresh scaffold should compile cleanly — if
not, try running `yarn install` again.
<details>
<summary>Plugin page not showing up</summary>
Verify that `app.packages` is set to `all` in your `app-config.yaml`. If you
use include/exclude filters, make sure your plugin package is not excluded.
</details>
<details>
<summary>`yarn new` fails during installation</summary>
Make sure you have run `yarn install` in the repository root first and that
your Node.js version matches the one required by the project.
</details>
<details>
<summary>TypeScript errors after scaffolding</summary>
Run `yarn tsc` from the repository root to check for type errors. A fresh
scaffold should compile cleanly — if not, try running `yarn install` again.
</details>