real docs, split README
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start by reviewing the existing README and the repository documentation layout; the issue does not name any other files or tests. Clarify how the README should be split, then determine the Sphinx/reStructuredText structure and Read the Docs setup. Done means the project has the agreed real documentation and a working Read the Docs site.
Written by the indexing model from the issue text.
Description
use sphinx / rst, readthedocs site.
- Dominant language
- Cython
- Stars
- 7
- Forks
- 3
- Avg merge
- 3m
- Merged PRs (30d)
- 3
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.
More from borgbackup/borghash
-
borgbackup/borghash#45 · 2 comments · 1 assignee ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
borgbackup/borghash#44 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
borgbackup/borghash#31 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
borgbackup/borghash#13 · 1 comment ·
-
borgbackup/borghash#43 · 15 comments · 1 reaction · 1 assignee ·
All issues in borgbackup/borghash
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
HarperFast/skills#96 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
infinispan/infinispan#18150 ·