openedx / openedx/api-doc-tools
Write instructions for devs about how to document APIs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7
- Forks
- 17
- PR merge metrics
- No merged PRs in 30d
Description
Make sure they are findable from the API Best Practices doc.
TBD: should the bulk of the instructions be in this repo?
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 API Best Practices doc, which should make the new developer instructions findable. Determine whether the bulk of the guidance belongs in this repository or elsewhere, then define the documentation location and link. Done means the instructions are written and discoverable from that document.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100