docs: add features overview and getting started guide#63
Merged
Conversation
- features.mdx: full feature overview, config reference, meta.json guide, markdown URLs, API reference page documentation - getting-started.mdx: updated with project structure, chronicle.yaml, meta.json, API reference, Docker setup Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughSummary by CodeRabbit
WalkthroughThis PR adds and updates documentation for the Chronicle example project. It introduces a new comprehensive Features page describing product capabilities, configuration, and UI behavior, and upgrades the Getting Started guide to provide complete setup instructions with examples covering prerequisites, installation, project structure, development workflow, deployment, and Docker support. ChangesDocumentation: Getting Started and Features Guide
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@examples/basic/content/docs/features.mdx`:
- Line 51: Update the user-facing copy string "**Open in AI** — copy as
markdown, open in ChatGPT or Claude" to capitalize "Markdown" so it reads
"**Open in AI** — copy as Markdown, open in ChatGPT or Claude"; locate and edit
the exact text in the examples/basic/content/docs/features.mdx file (the shown
user-facing sentence) to ensure consistency with technical documentation
styling.
In `@examples/basic/content/docs/getting-started.mdx`:
- Around line 13-19: The docs currently only show Bun commands under the
"Installation" and run sections; add equivalent npm (or npx) and pnpm command
variants so Node.js 20+ users can follow the guide. Update the "Installation"
code block (Installation heading) to include `npm install `@raystack/chronicle``
and `pnpm add `@raystack/chronicle`` alongside the Bun command, and similarly add
`npx`/`npm`/`pnpm` alternatives for the subsequent run/start examples (the
examples near the Installation and the two other command blocks referenced)
ensuring each code block lists Bun, npm, and pnpm variants in the same order for
consistency.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 33ad4e7b-c9bd-4fc2-8cc5-939f13efbfd7
📒 Files selected for processing (2)
examples/basic/content/docs/features.mdxexamples/basic/content/docs/getting-started.mdx
| - **robots.txt** — auto-generated | ||
| - **llms.txt** — AI-discoverable documentation index | ||
| - **`.md` URLs** — every page (docs and API) has a markdown URL for AI tools | ||
| - **Open in AI** — copy as markdown, open in ChatGPT or Claude |
There was a problem hiding this comment.
Capitalize “Markdown” in user-facing copy.
At Line 51, use “Markdown” (proper noun) for consistency with technical documentation style.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...for AI tools - Open in AI — copy as markdown, open in ChatGPT or Claude ## Develope...
(MARKDOWN_NNP)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@examples/basic/content/docs/features.mdx` at line 51, Update the user-facing
copy string "**Open in AI** — copy as markdown, open in ChatGPT or Claude" to
capitalize "Markdown" so it reads "**Open in AI** — copy as Markdown, open in
ChatGPT or Claude"; locate and edit the exact text in the
examples/basic/content/docs/features.mdx file (the shown user-facing sentence)
to ensure consistency with technical documentation styling.
Comment on lines
+13
to
19
| - [Bun](https://bun.sh) (recommended) or Node.js 20+ | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| npm install @raystack/chronicle | ||
| bun add @raystack/chronicle | ||
| ``` |
There was a problem hiding this comment.
Node prerequisite is listed but Node command path is missing.
Line 13 says Node.js 20+ is supported, but setup/run commands only show Bun. Please add npm/npx (or pnpm) equivalents so Node users can complete the flow.
Also applies to: 85-87, 112-115
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@examples/basic/content/docs/getting-started.mdx` around lines 13 - 19, The
docs currently only show Bun commands under the "Installation" and run sections;
add equivalent npm (or npx) and pnpm command variants so Node.js 20+ users can
follow the guide. Update the "Installation" code block (Installation heading) to
include `npm install `@raystack/chronicle`` and `pnpm add `@raystack/chronicle``
alongside the Bun command, and similarly add `npx`/`npm`/`pnpm` alternatives for
the subsequent run/start examples (the examples near the Installation and the
two other command blocks referenced) ensuring each code block lists Bun, npm,
and pnpm variants in the same order for consistency.
rohilsurana
reviewed
May 13, 2026
rohilsurana
approved these changes
May 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
bun run dev:examples:basic— both pages render🤖 Generated with Claude Code