openedx / openedx/openedx-filters
Address documentation improvement suggestions from community feedback
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 28
- Avg merge
- 3d 8h
- Merged PRs (30d)
- 8
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-filters/issues/183
- [ ] https://github.com/openedx/openedx-filters/issues/184
- [ ] https://github.com/openedx/openedx-filters/issues/185
- [ ] https://github.com/openedx/openedx-filters/issues/186
- [ ] https://github.com/openedx/openedx-filters/issues/187
- [ ] https://github.com/openedx/openedx-filters/issues/188
- [ ] https://github.com/openedx/openedx-filters/issues/189
- [ ] https://github.com/openedx/openedx-filters/issues/191
- [ ] https://github.com/openedx/openedx-filters/issues/190
- [ ] https://github.com/openedx/openedx-filters/issues/192
- [ ] https://github.com/openedx/openedx-filters/issues/73
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 reading the linked task issues 183–190, 191, 192, and 73, since this issue provides no files or entry points. Done means addressing all listed community-feedback documentation tasks and completing the full task list.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100