feat: richer init scaffolding with feature demos

Open
#142 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
typescript
Domain
cli, content, documentation

Research direction

Start at the chronicle init entry point and inspect how it generates chronicle.yaml and index.mdx. Define the generated Getting Started and Components pages around the listed features, then determine how the optional --with-api flag and sample OpenAPI spec fit into the scaffold. Done means a new project contains the agreed demos and explanatory config comments.

Written by the indexing model from the issue text.

Description

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
Dominant language
TypeScript
Stars
2
Forks
1
Avg merge
12h 29m
Merged PRs (30d)
12

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from raystack/chronicle

All issues in raystack/chronicle

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.