Imageomics / Imageomics/sum-buddy
Make a docs site
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 3
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
As @thompsonmj and I have discussed, sum-buddy is a larger package, in the sense of multiple moving parts, examples, and downstream applications that would benefit from being fleshed-out in a docs site. We should set up a Zensical site for sum-buddy to provide more user-friendly guidance.
Contributor guide
No contributing guide indexed for this repository
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 with the linked Zensical getting-started documentation and inspect sum-buddy's examples and downstream applications to determine the site's required guidance. Done means a Zensical site is set up for sum-buddy and provides user-friendly documentation for its multiple moving parts.
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
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100