openedx / openedx/docs.openedx.org
Add a documentation cookiecutter
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
See https://github.com/openedx/docs.openedx.org/issues/216 for more context.
Create a cookiecutter to generate the docs/ folder of an openedx repo based on the current best-practice recommendations.
Update the Sphinx How-To created in https://github.com/openedx/docs.openedx.org/pull/239 to use the cookiecutter instead of creating everything by hand.
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
Read issue 216 for the best-practice context, then inspect the existing docs/ structure and the Sphinx How-To from pull request 239. Create a cookiecutter that generates the recommended docs/ folder, and update that How-To to use it instead of manual setup; done means both the template and instructions are usable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100