openedx / openedx/openedx-platform
Readthedocs toctree clean-up
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
- A recent Issue/PR improved the docs with some new index pages for app-level docs, but they were dropped into the toctree at the top-level:
- This brought attention to some other toctree issues.
The requirements are human driven, but this plan and PR are AI generated:
- https://github.com/openedx/openedx-platform/pull/38692
- https://github.com/openedx/openedx-platform/blob/6a13210c51ca74a7f54aa9d4e9167dc32dde049d/docs/decisions/toctree-reorganization-plan.md
- The plan needs review to see if others agree with the proposed reorganization details.
- Someone who can build the docs locally would need to take over authorship of this PR. It has not yet been human reviewed.
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 reviewing docs/decisions/toctree-reorganization-plan.md alongside PR 38692, then build the documentation locally to inspect the proposed Read the Docs toctree changes. Done means the reorganization plan has received human review and the PR has a human author who can carry it forward.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100