Documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 10
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
Create READMEs for all projects and components, including installation and running instructions as well as overviews of functionality.
Create docstrings for all functions and classes of importance in libs and use Sphinx+GitHub workflows to automatically generate documentation which gets pushed to a GitHub page.
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 inventorying the projects, components, and important functions and classes in libs, then review the existing README files and repository workflows. Define the documentation scope, installation and run instructions, Sphinx configuration, and GitHub Pages publishing steps before implementing them. Done means all requested projects and components have overviews and instructions, important libs APIs have docstrings, and generated documentation is published through the workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, python
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100