jazzband/pip-tools

Refactor README

Open

#1845 opened on Apr 6, 2023

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (7,230 stars) (605 forks)batch import
docshelp wanted

Description

What's the problem this feature will solve?

Since the README file has become quite large, perhaps it's time we consider refactoring it.

Describe the solution you'd like

  • Make README small and concise focusing on important things
  • Keep on README description, svg image, installation and basic usage of the pip-tools
  • Move the other sections to https://pip-tools.rtfd.io/

References:

Alternative Solutions

N/A

Additional context

/cc @jamescooke

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Pythonpip toolsSphinx documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests refactoring the README.md to be more concise and move detailed sections to the readthedocs documentation. Review the current README.md in the repository root and the existing documentation structure under docs/. Check comments #1845 for additional context and references to similar refactors in other projects. The deliverable is a revised README.md and possibly updates to the docs/ folder.