Add comments to docs that cover dev mode warnings
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 230
- PR merge metrics
- No merged PRs in 30d
Description
The shortlinks in https://github.com/lit/lit.dev/pull/465 redirect to sections that explain specific issues that devmode warns about. There should be a comment in each of these locations so the hapless editor (ahem) knows to consider this factor rearranging docs.
We also probably need a policy about how to handle these over time. i.e., if Lit 3 eliminates a problem or adds a different solution for it, we still need to keep the Lit 2 shortlink (and associated doc) alive.
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 PR 465 and follow its shortlinks to identify each documentation location covering a dev mode warning. Add an editor-facing comment at every location, then document a policy for keeping Lit 2 shortlinks and docs available when later Lit versions change or remove the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100