Link to documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by checking the README and the package's PyPI project metadata, then compare them with the existing Read the Docs documentation. Add a discoverable documentation link in the README and, if supported by the project metadata, on PyPI; done means users can find the published docs from both entry points.
Written by the indexing model from the issue text.
Description
It was rather surprising for me when I noticed that this package actually has docs on readthedocs.
I only looked at the repository sidebar, in the readme and the pypi page.
Therefore it would seem beneficial to add a link to the documentation in the readme and potentially also in the pypi page (https://packaging.python.org/guides/distributing-packages-using-setuptools/#project-urls)
- Dominant language
- No language data
- Stars
- 152
- Forks
- 38
- Avg merge
- 6h 27m
- Merged PRs (30d)
- 4
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 jaraco/skeleton
-
Difficulty 1/5 Under an hour Newbie friendliness 91/100
-
Difficulty 3/5 1-2 days Newbie friendliness 67/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Similar issues
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P2
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
openclaw/openclaw#199885 · 2 comments · 1 reaction ·
Maintainers usually reply within 1 day
-
docs ready
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
schuyler/corvidae#999 · 1 comment ·
Maintainers usually reply within 1 day
-
proposal
Difficulty 1/5 Under an hour Newbie friendliness 68/100
j3ko/agent-plugins#29 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
area:docs bug good first issue priority:low
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
Maintainers usually reply within 1 day