feat: richer init scaffolding with feature demos
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 1
- Avg merge
- 12h 29m
- Merged PRs (30d)
- 12
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- typescript
- Domain
- cli, content, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100