Skip to content

docs: add Chronicle documentation site#20

Merged
rsbh merged 6 commits intomainfrom
docs_add_basic_docs
Mar 12, 2026
Merged

docs: add Chronicle documentation site#20
rsbh merged 6 commits intomainfrom
docs_add_basic_docs

Conversation

@rsbh
Copy link
Copy Markdown
Member

@rsbh rsbh commented Mar 11, 2026

Summary

  • Add docs/ folder with Chronicle's own documentation as MDX pages
  • Includes: Getting Started, CLI Commands, Configuration, Frontmatter, Components, Themes
  • Uses paper theme with llms enabled
  • chronicle.yaml configured for self-documenting site

Test plan

  • Run chronicle dev --content ./docs and verify all pages render
  • Verify sidebar ordering matches frontmatter order values
  • Check /llms.txt and /llms-full.txt routes work (requires llms PR)

🤖 Generated with Claude Code

Add docs/ folder with MDX documentation pages:
- Getting Started (install, quick start, project structure)
- CLI Commands (init, dev, build, start, serve)
- Configuration (full chronicle.yaml reference)
- Frontmatter (title, description, order, icon)
- Components (callouts, tabs, mermaid, code blocks, tables, images)
- Themes (default and paper)
- chronicle.yaml with paper theme and llms enabled

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 11, 2026

Warning

Rate limit exceeded

@rsbh has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 27 minutes and 22 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 1ba332f5-f17b-4938-b24d-af4424f91a17

📥 Commits

Reviewing files that changed from the base of the PR and between e976be8 and 351c92a.

📒 Files selected for processing (2)
  • README.md
  • docs/index.mdx
📝 Walkthrough

Walkthrough

Adds a Chronicle documentation site: one site config file and multiple new MDX docs covering getting started, CLI, configuration schema, frontmatter, built-in MDX components, themes, and Docker usage. No runtime code changes.

Changes

Cohort / File(s) Summary
Site Configuration
docs/chronicle.yaml
New site configuration defining metadata, theme ("paper"), navigation, search, llms toggle, and footer links.
Getting Started & CLI
docs/index.mdx, docs/cli.mdx
New getting-started guide and CLI reference (init, dev, build, start, serve) with usage, flags, and content-dir resolution.
Configuration Reference
docs/configuration.mdx
Comprehensive chronicle.yaml reference with full example, field descriptions, types, defaults, and API/OpenAPI section.
Content Authoring & Components
docs/frontmatter.mdx, docs/components.mdx
Documentation for page frontmatter (ordering, fields, navigation) and built-in MDX components (Callout, Tabs, Mermaid, code blocks, tables, images, links, details, overrides).
Themes & Docker
docs/themes.mdx, docs/docker.mdx
Theme descriptions (default, paper) with layout/features and Docker usage/examples for running Chronicle image.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Suggested reviewers

  • rohilsurana
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The pull request title 'docs: add Chronicle documentation site' accurately summarizes the main change: adding documentation files for the Chronicle project.
Description check ✅ Passed The pull request description clearly relates to the changeset, providing a summary of the documentation additions, listing included pages, configuration details, and a test plan.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs_add_basic_docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@rsbh rsbh requested a review from rohilsurana March 11, 2026 11:22
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/components.mdx`:
- Around line 67-72: The docs table incorrectly states Callout's outline default
as false; update the Callout prop table in docs/components.mdx to reflect that
Chronicle's wrapper (CalloutContainer) sets outline to true by default before
spreading user props, so change the `outline` default to `true` (or add a note
that Chronicle forces outline: true unless explicitly overridden) and mention
CalloutContainer by name so readers know the source of the default behavior.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 59792453-af71-4082-9873-dcb50b375866

📥 Commits

Reviewing files that changed from the base of the PR and between 2b6c947 and 77d277e.

📒 Files selected for processing (7)
  • docs/chronicle.yaml
  • docs/cli.mdx
  • docs/components.mdx
  • docs/configuration.mdx
  • docs/frontmatter.mdx
  • docs/index.mdx
  • docs/themes.mdx

rsbh and others added 5 commits March 11, 2026 17:42
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@rsbh rsbh merged commit ca271b9 into main Mar 12, 2026
1 check passed
@rsbh rsbh deleted the docs_add_basic_docs branch March 16, 2026 04:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants