tldraw/apps/docs/utils
alex 6cb797a074
Better generated docs for react components (#3930)
Before:
![Screenshot 2024-06-12 at 12 57
26](https://github.com/tldraw/tldraw/assets/1489520/2a9f6098-ef2a-4f52-88f5-d6e4311c067d)

After:
![Screenshot 2024-06-12 at 12 59
16](https://github.com/tldraw/tldraw/assets/1489520/51733c2a-a2b4-4084-a89a-85bce5b47672)

React components in docs now list their props, and appear under a new
"Component" section instead of randomly under either `Function` or
`Variable`. In order to have our docs generate this, a few criteria need
to be met:
1. They need to be tagged with the `@react` tsdoc tag
2. Their props need to be a simple type alias, typically to an
interface.

Both of these rules are enforced with a new lint rule - any component
tagged as `@public` will have these rules enforced.

### Change Type

- [x] `docs` — Changes to the documentation, examples, or templates.
- [x] `improvement` — Improving existing features
2024-06-13 13:09:27 +00:00
..
vector-db [docs] Autocomplete styling tweaks (#2732) 2024-02-05 20:46:07 +00:00
addAuthors.ts Add docs (#2470) 2024-01-15 12:33:15 +00:00
addContent.ts [docs] Fix missing Persistence page (#2828) 2024-02-13 16:19:17 +00:00
autoLinkDocs.ts docs: fix up gen links to point to the new /reference section (#2690) 2024-01-30 15:16:32 +00:00
ContentDatabase.ts Better generated docs for react components (#3930) 2024-06-13 13:09:27 +00:00
ContentVectorDatabase.ts Don't check api.json files into git (#3565) 2024-04-24 15:58:26 +00:00
debounce.ts Add docs (#2470) 2024-01-15 12:33:15 +00:00
nicelog.ts Add docs (#2470) 2024-01-15 12:33:15 +00:00
search-api.ts docs: rework search UI (#2723) 2024-02-05 14:32:50 +00:00
TldrawApiModel.ts Better generated docs for react components (#3930) 2024-06-13 13:09:27 +00:00