feat: richer init scaffolding with feature demos
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 48/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- typescript
- Área
- cli, content, documentation
Línea de trabajo
Comienza en el punto de entrada de chronicle init e inspecciona cómo genera chronicle.yaml e index.mdx. Define las páginas generadas de Getting Started y Components en torno a las funcionalidades indicadas y, después, determina cómo encajan en el scaffold el flag opcional --with-api y la especificación de OpenAPI de ejemplo. Se considera terminado cuando un proyecto nuevo contiene las demos acordadas y comentarios explicativos de configuración.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Problem
`chronicle init` creates a minimal scaffold: one `chronicle.yaml` and one `index.mdx` with basic frontmatter. New users don't see what Chronicle can do — callouts, code blocks, mermaid diagrams, API docs, versioning, etc.
Suggested Improvement
- Add 2-3 sample pages demonstrating key features:
- A "Getting Started" page with callouts, code blocks, and a table
- A "Components" page showing mermaid diagrams, admonitions, and images
- Optionally scaffold with `--with-api` flag to include a sample OpenAPI spec
- Add comments in the generated `chronicle.yaml` explaining each config section
- Lenguaje dominante
- TypeScript
- Estrellas
- 2
- Forks
- 1
- Merge medio
- 12 h 29 min
- PR fusionados (30 d)
- 12
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
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 raystack/chronicle
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 78/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 65/100
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 35/100
Todos los issues de raystack/chronicle
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
mksglu/context-mode#1200 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
jaegertracing/jaeger-ui#4506 ·
-
area:desktop area:ui bug platform:macos
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
anthropics/claude-code#96687 ·
-
good first issue
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
AOSSIE-Org/DebateAI#582 · 2 comentarios ·