tldraw/apps/docs/scripts
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
..
functions Better generated docs for react components (#3930) 2024-06-13 13:09:27 +00:00
check-broken-links.ts Add docs (#2470) 2024-01-15 12:33:15 +00:00
check-vector.ts Add docs (#2470) 2024-01-15 12:33:15 +00:00
create-api-markdown.ts Add docs (#2470) 2024-01-15 12:33:15 +00:00
fetch-api-source.ts Add docs (#2470) 2024-01-15 12:33:15 +00:00
fetch-releases.ts Add docs (#2470) 2024-01-15 12:33:15 +00:00
refresh-content.ts Add docs (#2470) 2024-01-15 12:33:15 +00:00
refresh-embeddings.ts docs: fix missing API entries (#3111) 2024-03-12 13:36:24 +00:00
reset-db.ts Don't check api.json files into git (#3565) 2024-04-24 15:58:26 +00:00
utils.ts Better generated docs for react components (#3930) 2024-06-13 13:09:27 +00:00