jaraco / jaraco/skeleton

Link to documentation

Open
#52 7 comments 0 reactions 0 assignees View on GitHub
help wanted
Dominant language
No language data
Stars
150
Forks
38
Avg merge
1m
Merged PRs (30d)
1

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)

Contributor guide

No contributing guide indexed for this repository

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.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.