python-poetry / python-poetry/website

Alternative installation methods are presented as steps

Open
#150 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
39
Forks
21
Avg merge
2h 5m
Merged PRs (30d)
2

Description

EDIT: I misread the docs! There are two alternative installation methods, not three.

To install poetry with pipx, there are two alternative installation methods, depending on how much control you need over versioning. You only want to use one of these alternatives. However, these two alternatives look like two steps, which you're supposed to do one after the other.

Screenshot of Poetry docs with alternative pipx installation methods which are numbered 1, 2, 3

It's a similar story for the 'With the official installer' tab.

Perhaps, instead of:

├1
├2
└3

We could organise it as:

├1
└2
 ├Option A
 └Option B

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Locate the installation documentation and inspect how the pipx alternatives and the official-installer tab are rendered as numbered steps. Update the structure so alternatives are clearly presented as options rather than sequential steps, then verify both sections render correctly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.