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

docs: organize docs/ by audience (guide / reference / explanation / internals) and add a real tutorial

Aperta Adatta ai principianti
  • Qualcosa non va?
#1,270 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-2 giorni
Idoneità per principianti
70/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
c, markdown
Ambito
documentation

Direzione di ricerca

Iniziate leggendo la directory docs/ esistente per comprendere la struttura piatta attuale. Identificate quali file appartengono a guida, riferimento, spiegazione e dettagli interni in base alla classificazione dell'issue. Create le nuove sottodirectory e spostate i file di conseguenza, aggiornando i collegamenti in index.md e altri documenti. Assicuratevi che la classe docs-claims PATHS e la build di Pages passino senza link interrotti. Infine, redigete un semplice tutorial in docs/guide/ con esempi eseguibili.

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

Descrizione

area:docs help wanted kind:decision

Problem. docs/ is 30 files in one flat directory, with no signal of audience.

  • Reference: SPEC, GRAMMAR, BUILTINS, STDLIB.
  • Explanation: OBSERVER, ARCHITECTURE, TRACE.
  • Internal engineering notes: JIT_STAGE5_INLINE_IC, TEST_COVERAGE_ANALYSIS, GAP_ANALYSIS, EMBED_OBSERVER_VALIDATION.
  • CI operations: CI.md.

index.md exists, but a newcomer cannot tell where to start, and there is no tutorial.

What mature languages do. Split by what the reader is doing: the Diátaxis quadrants of tutorial, how-to, reference and explanation. Python ships Tutorial / Library Reference / Language Reference / HOWTOs / What's New. Rust ships The Book / std docs / the Reference / Rust by Example / the Nomicon.

Bar.

  1. docs/guide/ holds a real tutorial whose every example runs under the executed-fence gate: install, first program, the observer in one page, a small real program.
  2. docs/reference/, docs/explanation/ and docs/internals/ (or move internals to hq) hold the existing files by audience. Every moved file is reachable from docs/index.md, which states the four sections and whom each serves.
  3. No broken links: the docs-claims PATHS class and the Pages build pass. Front doors (README, llms.txt) point at the guide first.
  4. A gate or the doc-enrolment population ensures that a new doc lands in one of the sections, not the root.

Ranked #3 of the docs follow-ups (2026-09-22 comparison with other languages). Mostly file moves, but many links.

Lingua principale
C
Stelle
3
Fork
7
Merge medio
4h 15m
PR unite (30g)
106

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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 InauguralSystems/EigenScript

Tutte le issue di InauguralSystems/EigenScript

Issue simili

Altre issue su C

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.