Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughUpdate docs, CLI, and build config: add new CLI flags and config fields, change content path resolution to be relative to the resolved Changes
Sequence Diagram(s)sequenceDiagram
participant CLI as CLI (chronicle.js)
participant Loader as loadCLIConfig
participant Resolver as resolveContentDir
participant FS as Filesystem
CLI->>Loader: parse flags (--config, --content, --preset)
Loader->>FS: locate resolved `chronicle.yaml` path
Loader->>Resolver: pass config + resolved configPath + content flag
Resolver->>FS: resolve final content directory (dirname(configPath) + config.content) or use content flag
Resolver-->>Loader: return contentDir
Loader-->>CLI: start dev/build with resolved paths
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 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 |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 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 161-162: The docs page mixes framework-specific Next.js wording
with framework-agnostic language; update the table entries that mention
Next.js/`<img>` to use neutral phrasing: change the HTML row that references the
`<img>` tag and any line containing “Next.js optimized” to instead say
“optimized Image component” (or similar neutral copy) for local images and
“standard <img> tag” for external images so the page consistently uses
framework-agnostic wording; locate and edit the table cell text matching the
strings "Local images — Rendered with optimized `Image` component (default
800x400)" and "External images — Rendered with standard `<img>` tag" and the
HTML `<img>` row to ensure consistent phrasing.
In `@docs/frontmatter.mdx`:
- Around line 83-87: Update the frontmatter docs to constrain the lastModified
field to a strict ISO-8601 format because the sitemap generation uses new
Date(...).toISOString(); change the description for the lastModified entry (the
"lastModified" frontmatter key) to require either a date-only format
(YYYY-MM-DD) or a full ISO datetime (e.g., YYYY-MM-DDTHH:MM:SSZ), and add one or
two examples showing both allowed formats so consumers know what to pass.
In `@packages/chronicle/package.json`:
- Line 54: The package.json currently pins "nitro": "3.0.260311-beta" which is a
pre-release; either change the dependency to the latest stable "2.13.2" or add a
short justification and testing note in the repo (e.g., in README or CHANGELOG)
explaining why Nitro v3 beta is required and listing compatibility checks
performed (Vite/Nitro integration, Node v20 requirement, import/path changes,
cloud provider bindings); update the "nitro" entry or add the justification
referencing the package.json "nitro" key and any test scripts or docs you used
to validate the beta.
🪄 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: 768bb301-5d79-4c40-9a38-6457ab6d1be9
⛔ Files ignored due to path filters (1)
bun.lockis excluded by!**/*.lock
📒 Files selected for processing (10)
.gitignoredocs/cli.mdxdocs/components.mdxdocs/configuration.mdxdocs/frontmatter.mdxdocs/index.mdxdocs/themes.mdxpackage.jsonpackages/chronicle/package.jsonvercel.json
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/configuration.mdx (1)
265-268: Clarify default enforcement in schema definition.The documented default of
falseforanalytics.enabledis correct and enforced at runtime via the config merging logic inpackages/chronicle/src/lib/config.ts:30(analytics: { enabled: false, ...userConfig.analytics }). However, the schema definition atpackages/chronicle/src/types/config.ts:66usesz.boolean().optional()without an explicit default, making the schema inconsistent with the actual runtime behavior. Consider adding.default(false)to the schema to align it with the runtime enforcement and improve maintainability.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/configuration.mdx` around lines 265 - 268, The analytics.enabled schema is optional in the Zod type but runtime config merging enforces a default of false; update the Zod definition for analytics.enabled in the config type (the schema entry currently using z.boolean().optional()) to include a default by changing it to z.boolean().default(false) (or remove .optional() and use .default(false)) so the type/schema matches the runtime merge behavior (see the config merge that sets analytics: { enabled: false, ...userConfig.analytics }).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/configuration.mdx`:
- Around line 265-268: The analytics.enabled schema is optional in the Zod type
but runtime config merging enforces a default of false; update the Zod
definition for analytics.enabled in the config type (the schema entry currently
using z.boolean().optional()) to include a default by changing it to
z.boolean().default(false) (or remove .optional() and use .default(false)) so
the type/schema matches the runtime merge behavior (see the config merge that
sets analytics: { enabled: false, ...userConfig.analytics }).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 8d6fcf5c-f60c-45e3-8141-830cca5f8dfb
⛔ Files ignored due to path filters (1)
bun.lockis excluded by!**/*.lock
📒 Files selected for processing (12)
.gitignoredocs/chronicle.yamldocs/cli.mdxdocs/components.mdxdocs/configuration.mdxdocs/frontmatter.mdxdocs/index.mdxdocs/themes.mdxpackage.jsonpackages/chronicle/package.jsonpackages/chronicle/src/cli/utils/config.tsvercel.json
✅ Files skipped from review due to trivial changes (8)
- docs/themes.mdx
- .gitignore
- vercel.json
- docs/chronicle.yaml
- packages/chronicle/package.json
- docs/frontmatter.mdx
- docs/components.mdx
- docs/index.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- package.json
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
--config,--content,--preset) and config fields (content,preset)vercel.json)config.contentpath resolution to be relative to config file location (not CWD)dev:docsscript, updatebuild:docsto use--configflag3.0.260311-beta.output/and.vercel/to.gitignoreTest plan
bun run dev:docsstarts dev server with correct content resolutionbun run build:docsbuilds successfully🤖 Generated with Claude Code