openedx / openedx/openedx-events
Address documentation improvement suggestions from community feedback
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 13
- Forks
- 33
- Avg merge
- 14h 37m
- Merged PRs (30d)
- 4
Description
Description
Feedback from a recent developer experience survey has highlighted several areas where the current documentation can be improved to better support developers using the Open edX platform. This issue addresses these concerns by enhancing the documentation to make it more comprehensive, accessible, and user-friendly.
The overall objective of this issue is to address all community feedback to improve the library documentation.
### Tasks
- [ ] https://github.com/openedx/openedx-events/issues/360
- [ ] https://github.com/openedx/openedx-events/issues/361
- [ ] https://github.com/openedx/openedx-events/issues/362
- [ ] https://github.com/openedx/openedx-events/issues/363
- [ ] https://github.com/openedx/openedx-events/issues/364
- [ ] https://github.com/openedx/openedx-events/issues/365
- [ ] https://github.com/openedx/openedx-events/issues/366
- [ ] https://github.com/openedx/openedx-events/issues/367
- [ ] https://github.com/openedx/openedx-events/issues/368
- [ ] https://github.com/openedx/openedx-events/issues/369
- [ ] https://github.com/openedx/openedx-events/issues/370
- [ ] https://github.com/openedx/openedx-events/issues/357
- [ ] https://github.com/openedx/openedx-events/issues/421
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 by reviewing the linked task issues 360–370, 357, and 421 to understand the individual documentation changes requested by the survey feedback. Done means the scope of each linked task has been addressed and the documentation is improved across all listed areas.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100