Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto Apto para principiantes
  • ¿Algo no está bien?
#1,270 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-2 días
Aptitud para principiantes
70/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
c, markdown
Área
documentation

Línea de trabajo

Comience leyendo el directorio docs/ existente para comprender la estructura plana actual. Identifique qué archivos pertenecen a guía, referencia, explicación e internos según la clasificación del issue. Cree los nuevos subdirectorios y mueva los archivos en consecuencia, actualizando los enlaces en index.md y otros documentos. Asegúrese de que la clase docs-claims PATHS y la compilación de Pages pasen sin enlaces rotos. Finalmente, redacte un tutorial simple en docs/guide/ con ejemplos ejecutables.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Done when

  • Decision recorded in a comment here: split docs/ by audience (docs/guide/ tutorial + docs/reference/ + docs/explanation/ + docs/internals/, or internals moved to hq) or keep docs/ flat with docs/index.md as the only map. Also: whether internal engineering notes (JIT_STAGE5_INLINE_IC, TEST_COVERAGE_ANALYSIS, GAP_ANALYSIS, EMBED_OBSERVER_VALIDATION) stay public. Name the chosen option and why.
  • If adopted: docs/guide/ holds a tutorial (install, first program, the observer in one page, one small real program) whose every example runs under the executed-fence gate.
  • If adopted: every existing docs/*.md lives in exactly one section directory; docs/index.md names the four sections and whom each serves and links every moved file; README.md and llms.txt link the guide first.
  • If adopted: tools/docs_claims_check.sh (PATHS class) and the Pages build pass with zero broken links, and a gate refuses a new .md at the docs/ root (planted once).
  • If rejected: close with the reason.
Lenguaje dominante
C
Estrellas
3
Forks
7
Merge medio
4 h 5 min
PR fusionados (30 d)
116

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de InauguralSystems/EigenScript

Todos los issues de InauguralSystems/EigenScript

Issues similares

Más issues de C

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.