Link to documentation

Open
#52 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

  • #53 by @septatrix — closed without merging
  • #221 by @Furox-Art — closed without merging

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

help wanted

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from jaraco/skeleton

All issues in jaraco/skeleton

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.