DOCS: Rewrite AboutCode toolkit docs according to Diátaxis framework
@NobleCoder69 arbeitet bereits daran.
Seit 15.12.2025.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- markdown
- Bereich
- documentation
Rechercherichtung
Das Issue verweist auf die Dokumentation des AboutCode-Toolkits unter aboutcode.readthedocs.io/projects/aboutcode-toolkit/ sowie auf das Diátaxis-Framework; beginne damit, die bestehende Dokumentationsstruktur anhand des Frameworks zu überprüfen. Die Aufgabe ist erledigt, wenn die Dokumentation des Toolkits gemäß Diátaxis neu geschrieben und organisiert wurde und die daraus hervorgegangenen Seiten auf der Dokumentationssite des Projekts veröffentlicht sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Rewrite the documentation of AboutCode toolkit docs (see https://aboutcode.readthedocs.io/projects/aboutcode-toolkit/) according to Diátaxis framework to make the docs better.
- 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 71 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 52 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 53 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 155 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 242 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
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 92/100
danilogiles/enki-browser#113 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 85/100
Maintainer antworten meist innerhalb von 1 Tag
-
ux
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
evcc-io/evcc#35605 · 1 Kommentar ·
Maintainer antworten meist innerhalb von 1 Tag
-
bug triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 74/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 95/100
weavefox/awesome-opc#29 ·
Maintainer antworten meist innerhalb von 1 Tag