Imageomics / Imageomics/distributed-downloader
Improve documentation
Open
documentation
- Dominant language
- Python
- Stars
- 5
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
This repo is complex and should have more robust documentation, i.e., a [MkDocs](https://www.mkdocs.org/) site for use and development instructions. It should also have contributing guidelines, as alluded to in the README.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by reviewing the README and the repository's current documentation structure, then consult MkDocs guidance for a possible site layout. Done means the repository has usable instructions for users and developers, a MkDocs documentation site, and contributing guidelines linked from the README.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100