Include web service documentation for each release
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
This issue is about importing the list of web services in each Moodle release and pulling them in to the dev docs as a JSON file which we can render to devdocs.
This could then be extended to add searchability, and show other metadata where possible.
Perhaps the WS docs can also be pulled in?
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 describes importing the web-service list for each Moodle release into a JSON file rendered in the developer docs, with possible search and metadata extensions. Start by locating how release documentation and rendered data are currently assembled; done should mean the relevant service list is imported and displayed for each release, with any extension scope agreed first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100