openedx / openedx/edx-django-utils
Improve how docs outside the main docs directory get included
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 28
- Forks
- 31
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 1
Description
See the following PR for an alternative possibility of using automatically created symlinks, rather than having to create duplicate files, to index other docs in the repository. This PR was closed in draft, but someone might want to take it over the line.
Alternatively, others may have resolved this problem in another way in other repos. Outreach can be done to determine how this is handled elsewhere.
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 the closed draft PR #293 and its proposed symlink approach. Compare how other repositories include documentation outside the main docs directory, then define and implement a chosen approach that indexes those documents without requiring duplicate files.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100