Make a docs site
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 38/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Quiet
- Domain
- documentation
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.
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.
- Dominant language
- Python
- Stars
- 3
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from Imageomics/sum-buddy
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Imageomics/sum-buddy#51 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
Imageomics/sum-buddy#54 ·
-
Sort outputsOpen
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Imageomics/sum-buddy#43 · 1 reaction ·
-
structure
Difficulty 3/5 1-2 days Newbie friendliness 55/100
Imageomics/sum-buddy#42 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 25/100
Imageomics/sum-buddy#34 ·
All issues in Imageomics/sum-buddy
Similar issues
-
automated endpoint-dead needs-curation
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
almanac-data/climate-almanac#138 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
OceanDataTools/openrvdas#760 ·
Maintainers usually reply within 1 day
-
level/subtask type/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
wazuh/wazuh-virtual-machines#1091 ·
Maintainers usually reply within 1 day
-
Python: Bug: ChatMessageContent.from_element drops AudioContent and BinaryContent into raw TextContentPossibly taken @halcyon-past claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
microsoft/semantic-kernel#14824 · 1 comment ·
Maintainers usually reply within 3 days
-
help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
stack314/django-neolith#142 · 1 comment ·
Maintainers usually reply within 1 day