Skip to content

feat: richer init scaffolding with feature demos #142

@rohilsurana

Description

@rohilsurana

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions