What do the different node colors in the Reactive Update lifecycle diagrams mean?
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 142
- Forks
- 230
- PR merge metrics
- No merged PRs in 30d
Description
Context
Issue raised in discord.
We use different colors (green, blue, gray) in the reactive lifecycle diagrams but don't document what the colors mean.
Completion criteria
Add a key to explain the different colors, or alternatively re-create the images without the different colors.
What do the colors mean?
From Justin: Green are methods you can implement or override, blue are APIs you call or use as-is from LitElement.
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 the reactive update lifecycle diagrams linked in the issue and inspect the surrounding lifecycle documentation. Add a key explaining that green marks methods users can implement or override and blue marks APIs used as-is from LitElement, or remove the color distinctions; done means the diagrams' colors are documented or no longer ambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 62/100