DOCS: Create AboutCode doc system
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 30/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- javascript, markdown
- Bereich
- documentation
Rechercherichtung
Beginne mit der Durchsicht der bestehenden Dokumentation unter aboutcode.readthedocs.io/ und des im Issue verlinkten Diátaxis-Frameworks. Lege die vorgeschlagene Struktur und die Richtlinien für die Projektdokumentation, README-Dateien, CONTRIBUTING-Dateien und Repository-Beschreibungen fest; als abgeschlossen gilt die Aufgabe, wenn das Dokumentationssystem veröffentlicht ist und erklärt, wie AboutCode-Projekte es anwenden sollen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
To improve and standardize the documentation across AboutCode projects, we plan to implement a documentation system on https://aboutcode.readthedocs.io/. This system will consist of pages inspired by the Divio documentation system, which explains the Diátaxis framework and its application to AboutCode projects.
Beyond outlining how project docs should be structured it the docs system should also provide guidance on README, CONTRIBUTING and repository descriptions.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 9
- Forks
- 17
- Ø Merge
- 7 Std. 55 Min.
- Gemergte PRs (30 T.)
- 2
Entwicklungsumgebung
Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus aboutcode-org/www.aboutcode.org
-
Making all post button.Evtl. vergeben @sarthaklole hat das vor 70 Tagen übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
aboutcode-org/www.aboutcode.org#117 · 3 Kommentare ·
-
WWW: Reduce frequency of update-releasesEvtl. wieder frei @johnmhoran hat das vor 51 Tagen übernommen, und es ist kein Pull Request offen. Offenci-workflow
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 45/100
aboutcode-org/www.aboutcode.org#180 · 1 zugewiesene Person ·
-
DOCS: Create new AboutCode stack diagram(s)Evtl. wieder frei @hixvikas hat das vor 52 Tagen übernommen, und es ist kein Pull Request offen. Offendocumentation
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 35/100
aboutcode-org/www.aboutcode.org#166 · 1 Kommentar ·
-
WWW: Create About top level page?Evtl. vergeben @pombredanne hat das vor 154 Tagen übernommen. Offenwebsite
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 35/100
aboutcode-org/www.aboutcode.org#164 · 1 Reaktion · 1 zugewiesene Person ·
-
WWW: Add Initiatives and grant ProjectsEvtl. wieder frei @mjherzog hat das vor 241 Tagen übernommen, und es ist kein Pull Request offen. Offenenhancement needs design website
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
aboutcode-org/www.aboutcode.org#141 · 1 zugewiesene Person ·
Alle Issues in aboutcode-org/www.aboutcode.org
Ähnliche Issues
-
step.duration reflects only the last retry attempt (HelperStep.run() overwrites startTime)Evtl. vergeben @mirao hat das heute übernommen. Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
codeceptjs/CodeceptJS#5774 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Status: Unconfirmed
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 76/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
AllTheMods/ATM10-Aeronautics#151 ·
Maintainer antworten meist innerhalb von 4 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
feimacode/open-design-agent-kit#66 ·
Maintainer antworten meist innerhalb von 1 Tag