Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

CRAVEX-Docs: Improve documentation

Aperta
  • Qualcosa non va?
#27 15 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@pombredanne ci sta già lavorando.

Dal 28/5/2026.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript, markdown, wordpress
Ambito
content, documentation, web-dev

Direzione di ricerca

Inizia facendo un inventario dei contenuti Docusaurus/Markdown esistenti nel repository www.aboutcode.org e degli attuali siti WordPress e Read the Docs/Sphinx descritti nell’issue. Definisci un piccolo incremento della documentazione con un risultato specifico per iniziare prima di modificare qualsiasi cosa; il lavoro sarà completato quando sarà disponibile una guida o un tutorial pubblicato che possa ricevere feedback dalla community.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
JavaScript
Stelle
9
Fork
17
Merge medio
7h 55m
PR unite (30g)
2

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aboutcode-org/www.aboutcode.org

Tutte le issue di aboutcode-org/www.aboutcode.org

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.