NASA-AMMOS / NASA-AMMOS/AIT-GUI
Add documentation on event bus and potential triggers
Open
Nobody has claimed this yet.
documentation
- Dominant language
- JavaScript
- Stars
- 31
- Forks
- 15
- Avg merge
- 1m
- Merged PRs (30d)
- 1
Description
The event bus is under (read, not) documented at the moment. It would be helpful to specify what events users could encounter in the system through normal use as well. This would help with using components such as the "LED" / sim status indicators.
Contributor guide
No contributing guide indexed for this repository
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 by locating the event bus and the existing documentation, then trace the events exposed during normal system use. Check how those events relate to the LED and sim status indicators. Done means documenting the relevant events and potential triggers clearly enough for users to understand them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100