Provide comprehensive context regarding extensible features and listeners in Addon documentation
Open
Nobody has claimed this yet.
addons
documentation
help-wanted
pinned
- Dominant language
- Ruby
- Stars
- 2k
- Forks
- 281
- Avg merge
- 2h 14m
- Merged PRs (30d)
- 6
Description
After the changes in #1379, the Addon documentation is missing two important aspects:
- It should contain examples on how to extend every single feature that can be enhanced (further details in this comment).
- It should contain an example on how an addon can instantiate multiple listeners (relevant discussion linked here).
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 Addon documentation and the two discussions linked from #1379. Identify every feature that can be extended, add an example for each, and add an example showing multiple listeners; done means both requested aspects are covered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100