CRAVEX-Docs: Improve documentation

Offen
  • Stimmt etwas nicht?
#27 15 Kommentare 0 Reaktionen 1 zugewiesene Person Auf GitHub ansehen

@pombredanne arbeitet bereits daran.

Seit 28.5.2026.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Muss geklärt werden
Aktivitätsstatus
Veraltet
Tech-Stack
javascript, markdown, wordpress
Bereich
content, documentation, web-dev

Rechercherichtung

Beginne damit, die vorhandenen Docusaurus/Markdown-Inhalte im Repository www.aboutcode.org sowie die in diesem Issue beschriebenen aktuellen WordPress- und Read the Docs/Sphinx-Websites zu inventarisieren. Definiere vor jeder Änderung einen kleinen Dokumentationsschritt mit einem konkreten Getting-Started-Ergebnis; abgeschlossen ist die Arbeit, wenn ein veröffentlichter Leitfaden oder ein Tutorial vorliegt, zu dem die Community Feedback geben kann.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation

We need improve the user experience in getting started with DejaCode and CRAVEX by updating the AboutCode.org website and the documentation of the AboutCode projects. We should also do an overhaul of the AboutCode's information architecture and supporting systems so it's easier to participate and contribute to AboutCode educational materials using a git-based workflow.

The goal of this new documentation issue is to provide a smooth "getting started" experience and comprehensive suite of guides with educational materials (e.g. tutorials) assisting users with CRA compliance using Dejacode CRAVEX features and AboutCode suite overall.

I suggest we execute this in small increments, creating and publishing the improved and new documentation after each increment, including code examples and other improvements as needed, closing each increment with a blog post that summarizes the new documentation so that we can get community feedback. For this let's track these issues:

Discussed also in https://github.com/orgs/aboutcode-org/discussions/195

Originally posted by pombredanne May 22, 2025
Hey, we need to up our game on the overall project docs and web site as I have received a lot of less positive feedback
Right now aboutcode.org is using wordpress and elementor
And the read the doc web sites are using Restructured text and Sphinx

The issues to me are:

  • we can change the look and feel, but more importantly is the "architecture" of the information about the overall project and how to get started that is the most pressing issue
  • we will need something that's based on text files in git repos, rather that wordpress which does not help much with participation

Inputs and suggestions and help are mucho welcomed. I am considering organizing a commando hackathon thing to get us started.

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

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus aboutcode-org/www.aboutcode.org

Alle Issues in aboutcode-org/www.aboutcode.org

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.