Content script UI options API reference is hard to follow
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 10.5k
- Forks
- 564
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
Try to find the docs for the append option here: https://wxt.dev/api/reference/wxt/client/functions/createShadowRootUi.html
You can't lol. Well, you can, but people will give up before finding it.
We could duplicate the JSDoc between the three options, but then they'd get out of sync. Maybe that's worth it for ease of use. Here's where the types are located: https://github.com/wxt-dev/wxt/blob/a38e3c27330ab82f9c136191fc85b9b101516915/packages/wxt/src/client/content-scripts/ui/types.ts
Originally reported here: https://discord.com/channels/1212416027611365476/1296842665249472614/1342135208220299274
Reproduction
https://wxt.dev/api/reference/wxt/client/functions/createShadowRootUi.html
Steps to reproduce
N/A
System Info
N/A
Used Package Manager
npm
Validations
- Read the Contributing Guidelines.
- Read the docs.
- Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
- Check that this is a concrete bug. For Q&A open a GitHub Discussion or join our Discord Chat Server.
- The provided reproduction is a minimal reproducible example of the bug.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with packages/wxt/src/client/content-scripts/ui/types.ts and compare its option JSDoc with the generated createShadowRootUi API reference at wxt.dev/api/reference/wxt/client/functions/createShadowRootUi.html. Improve the reference so the append option and the other content-script UI options are easy to find, while keeping their documentation maintainable and synchronized.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100