jazzband/pip-tools

Refactor README

Open

Aperta il 6 apr 2023

Vedi su GitHub
 (6 commenti) (0 reazioni) (0 assegnatari)Python (7230 star) (605 fork)batch import
docshelp wanted

Descrizione

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

Guida contributor

Tech stack
python
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
active
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Pythonpip toolsSphinx documentation
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80
Direzione di ricerca
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.