openedx / openedx/api-doc-tools

Pick an API to completely finish, and finish it.

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7
Forks
17
PR merge metrics
No merged PRs in 30d

Description

This issue has no description.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue provides no files, tests, API name, or entry point to inspect. Start by reviewing the repository’s API documentation tooling and existing incomplete APIs, then identify one API with a bounded scope. Done means that API is fully documented and generated documentation checks pass, but the issue does not define which API or completion criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
10/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.