[docs] Add callouts and troubleshooting sections
- Dominant language
- TypeScript
- Stars
- 10.9k
- Forks
- 543
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 114
Description
The old documentation had many of these that were useful that are missing on the new docs. We should try to port these over to the new docs (matching the new style of course).
For instance, developers are probably going to be tempted to use `Tooltip` when trying to create things like the infotips on the docs, when they should actually use ``.
No matter how much we try to optimize the API, there are going to be potential areas that may be confusing or need workarounds to document. It's a good idea to list as many of these as we can in the docs upfront to ensure devs are aware.
Contributor guide
Research direction
Compare the old documentation with the new documentation to identify missing callouts and troubleshooting guidance. Start with the Tooltip and example, then determine the relevant new-docs locations and style conventions. Done means the useful guidance and workarounds have been ported consistently, with confusing API areas documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100