Grimoire docs need examples

Abierto Apto para principiantes

#803 abierto el 9/7/2026 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad: 2/5
Tiempo estimado: 1-3 horas
Aptitud para principiantes: 68/100

Tipo de issue: Documentación
Claridad: Bastante claro
Estado de actividad: Tranquilo
Área: documentation

Línea de trabajo

Comienza localizando la documentación de referencia de la API de módulos en el Resyntax Grimoire y compárala con otras secciones de la documentación de Resyntax que ya utilizan @examples. Añade ejemplos adecuados a las referencias de API relevantes y, después, verifica que cada sección de documentación modificada se renderice y demuestre su API según lo previsto.

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

Descripción

documentation

The various module API reference docs in the Resyntax Grimoire don't use @examples anywhere. They should, like the other sections of the Resyntax docs do.

Lenguaje dominante: Racket
Estrellas: 70
Forks: 11
Métricas de merge de PR: Sin PR fusionados en 30 d

Guía de contribución

Abrir la guía de contribución

Primeros pasos

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

Más de jackfirth/resyntax

Docs previews don't work quite right Abierto

documentation

Dificultad 4/5 3-5 días Aptitud para principiantes 45/100

jackfirth/resyntax#831 · Abierto el 15/7/2026
UTS checker and renderer are completely untested Abierto

testing

Dificultad 4/5 3-5 días Aptitud para principiantes 45/100

jackfirth/resyntax#822 · Abierto el 14/7/2026
Meta-tests for resyntax/test failure reporting Abierto

testing

Dificultad 3/5 1-2 días Aptitud para principiantes 75/100

jackfirth/resyntax#821 · Abierto el 14/7/2026
Cover the CLI's run and output paths Abierto

testing

Dificultad 4/5 3-5 días Aptitud para principiantes 68/100

jackfirth/resyntax#818 · Abierto el 14/7/2026
New rule: `Shared else-value for if/case` Abierto

new lint

Dificultad 3/5 1-2 días Aptitud para principiantes 55/100

jackfirth/resyntax#784 · 1 reacción · Abierto el 21/3/2026

Todos los issues de jackfirth/resyntax

Issues similares

OGS AmBe example has no source.timing block, so every event sits at time zero Abierto

Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100

lanl/ScintiPix#61 · Abierto el 24/9/2026
Compatibility certification request for FJ-EAP 2.1.0 for Jakarta EE Platform 11 Abierto

certification

Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100

jakartaee/platform#1359 · Abierto el 24/9/2026
Fee reimbursement for trade 496343 Abierto

Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100

bisq-network/support#2181 · Abierto el 24/9/2026
documentation: direction-hint specifies no default Abierto

Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100

w3c-cg/mnx#553 · Abierto el 24/9/2026
tutorial updates Abierto

Dificultad 1/5 Menos de una hora Aptitud para principiantes 80/100

sveltejs/svelte.dev#2241 · Abierto el 23/9/2026

Más issues de Documentation