[docs] Migrate Files API to /docs/api/files
Open
Nobody has claimed this yet.
documentation
migration
- Dominant language
- TypeScript
- Stars
- 74
- Forks
- 652
- Avg merge
- 2d 50m
- Merged PRs (30d)
- 12
Description
The URL of the page on https://docs.moodle.org/dev/
https://docs.moodle.org/dev/File_API
Is this documentation specific to a Moodle version?
Yes
What location would you suggest in the new docs?
/docs/api/files/index.md
We need to migrate:
- File_API #59
- FIle_API_internals #59
- Using_the_File_API_in_Moodle_forms
These should all be a part of the /docs/api/files subtree
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 comparing the existing File_API page at https://docs.moodle.org/dev/File_API with the proposed /docs/api/files/index.md location. Check the migration status of File_API, FIle_API_internals, and Using_the_File_API_in_Moodle_forms, then confirm that all three pages are represented under the /docs/api/files subtree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100