Lepší README
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 46
- Forks
- 115
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Hlavně aby dokumentovalo, jak rozběhat projekt a co je účelem webovky (a co účelem té webovky - už - není). Viz https://github.com/pyvec/python.cz/pull/559
Hlavně zmínit, že skoro všechno je prostě zdokumentováno v dokumentaci MkDocs a hlavně mkdocs-material
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit README und prüfe den referenzierten Pull Request #559. Sieh dir die vorhandene MkDocs- und mkdocs-material-Dokumentation an, um zusammenzufassen, wie das Projekt ausgeführt wird, wofür die Website gedacht ist und welche Verantwortlichkeiten sie nicht mehr hat. Als erledigt gilt die Aufgabe, wenn das README die Leser auf die relevante Dokumentation verweist und Einrichtung und Zweck klar abdeckt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100