openedx / openedx/openedx-platform
[API] Help & Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Functional Area: Help & Documentation
Endpoints under this functional area:
| Module | API Version | Resource / Endpoint | HTTP Method | Description |
|---|---|---|---|---|
| Help URLs | v1 | /contentstore/v1/help_urls |
GET | Retrieves URLs for platform help documentation. Returns a JSON dictionary mapping keys like "default", "home", "develop_course" to their respective help pages. Useful for AI chatbots, external tools, or automated guides to fetch context-specific help URLs for users. No parameters required. |
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
The issue names the /contentstore/v1/help_urls GET endpoint but no file, documentation location, or test. Start by locating the endpoint implementation and existing Help & Documentation materials, then confirm what documentation change is expected. Done should mean the requested help URL behavior or documentation is clearly covered and any relevant checks pass.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100