Skip to content

feat: update docs and add vercel.json#25

Open
rsbh wants to merge 6 commits intomainfrom
fix_docs
Open

feat: update docs and add vercel.json#25
rsbh wants to merge 6 commits intomainfrom
fix_docs

Conversation

@rsbh
Copy link
Copy Markdown
Member

@rsbh rsbh commented Mar 30, 2026

No description provided.

rsbh and others added 6 commits March 30, 2026 14:45
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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 30, 2026

📝 Walkthrough

Summary by CodeRabbit

  • New Features

    • Added new configuration options: url for SEO/metadata, llms for LLM endpoint generation, and analytics with Google Analytics support.
    • Added lastModified frontmatter field to track page update dates.
    • Enhanced CLI commands to accept content path and build preset options.
  • Documentation

    • Updated CLI documentation, component references, and getting started guide.
    • Paper Theme now documented as light mode only.
  • Chores

    • Updated build and deployment configuration.

Walkthrough

This PR updates documentation, configuration, and build tooling to reflect a migration from Next.js to Vite + Nitro, adds new configuration options for SEO, LLMs, and analytics, updates CLI command signatures with new flags for content path and deployment preset, and introduces build scripts for the CLI and documentation.

Changes

Cohort / File(s) Summary
Build Configuration & Scripts
package.json, packages/chronicle/package.json, vercel.json
Added build:cli and build:docs scripts; pinned nitro to version 3.0.260311-beta; added Vercel build configuration with build command and output directory settings.
Documentation Updates
docs/cli.mdx, docs/components.mdx, docs/configuration.mdx, docs/frontmatter.mdx, docs/index.mdx, docs/themes.mdx
Documented new CLI flags (-c, --content and --preset); removed Next.js references from component docs; added new configuration fields (url, llms, analytics) with reference documentation; introduced lastModified frontmatter field; updated framework description from Next.js to Vite + Nitro; noted Paper Theme light-mode-only feature.
Ignore Rules & Version Control
.gitignore
Added .output/ and .vercel/ directory entries to ignore list.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • rohilsurana
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive No pull request description was provided by the author, which limits clarity about the intent and scope of the changes. Add a detailed description explaining the motivation for these changes, how the documentation updates align with the framework transition, and the purpose of the new Vercel configuration.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: update docs and add vercel.json' accurately captures the main changes in the pull request, which include documentation updates across multiple files and the addition of a new Vercel configuration file.
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
  • Commit unit tests in branch fix_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.

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: 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

📥 Commits

Reviewing files that changed from the base of the PR and between 8c3b2b6 and 190588d.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (10)
  • .gitignore
  • docs/cli.mdx
  • docs/components.mdx
  • docs/configuration.mdx
  • docs/frontmatter.mdx
  • docs/index.mdx
  • docs/themes.mdx
  • package.json
  • packages/chronicle/package.json
  • vercel.json

Comment on lines +161 to 162
- **Local images** — Rendered with optimized `Image` component (default 800x400)
- **External images** — Rendered with standard `<img>` tag
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Docs are still framework-inconsistent in this page.

Good update here, but this page still says “Next.js optimized for local” at Line 206 (<img> row in HTML overrides table). Please align that line too so the page doesn’t mix framework-agnostic and Next.js-specific wording.

Also applies to: 174-174

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/components.mdx` around lines 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.

Comment on lines +83 to +87
Optional date string indicating when the page was last updated.

```yaml
lastModified: "2026-03-30"
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

lastModified format should be constrained to avoid sitemap runtime failures.

“Optional date string” is too broad. Since sitemap generation converts this value with new Date(...).toISOString(), invalid formats can crash the sitemap route. Please document a strict ISO-8601 format (e.g., YYYY-MM-DD or full ISO datetime).

✏️ Suggested doc fix
-Optional date string indicating when the page was last updated.
+Optional ISO-8601 date string indicating when the page was last updated (recommended: `YYYY-MM-DD`).

 ```yaml
 lastModified: "2026-03-30"
</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

```suggestion
Optional ISO-8601 date string indicating when the page was last updated (recommended: `YYYY-MM-DD`).

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/frontmatter.mdx` around lines 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.

"mermaid": "^11.13.0",
"minisearch": "^7.2.0",
"nitro": "latest",
"nitro": "3.0.260311-beta",
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🌐 Web query:

Nitro release notes: what changed in version 3.0.260311-beta, and what is the latest stable Nitro 3.x release? Please include any known breaking changes or regressions affecting nitro/vite.

💡 Result:

In version 3.0.260311-beta of Nitro (nitrojs/nitro), key changes include: 🚀 Enhancements: - Export http utils from nitro (#4097) - vite: Support preview (#4090), respect vite mode for env loading (#4082), auto-detect client entry (#4059), use srvx loader for preview (#3999) - nitro deploy command (#4042), nitro preview (#4024) - tasks: Expose req and waitUntil in context (#4037) - Support zstd for compressPublicAssets (#3934) 🔥 Performance: - Optimize duplicate handler filtering (#4003) 🩹 Fixes: - config: Apply $production/$development layers when NODE_ENV unset (#4066) - vite: Avoid duplicate nitro plugins on nitro build, run scheduled tasks during vite dev (#4076), remove keep-alive header from worker, remove chunk config when inlineDynamicImports enabled, use sec-websocket-protocol to detect Vite WS (#4098) - Migrate to unjs/ocache (#4087), improve builder auto-detection (#4058) 📖 Documentation: - cloudflare: Fix env bindings access pattern for Nitro v3 (breaking change) (#4064) 🌊 Types and Preset Changes: - Various type updates and new presets like zephyr (#4038) The latest stable Nitro 3.x release: There is no stable 3.x release yet; 3.0.260311-beta (Mar 11, 2026) is the latest beta. The overall latest stable is v2.13.2 (Mar 20, 2026) from the v2 branch. Docs explicitly note "For the current stable release, see Nitro v2." Known breaking changes/regressions affecting nitro/vite: In v3 beta broadly - package rename nitropack → nitro, imports nitropack/runtime/* → nitro/*, eventHandler → defineHandler (H3 v2), createError → HTTPError, Node.js min v20. In this specific beta: cloudflare env bindings access pattern changed (noted as breaking). Vite-related fixes suggest prior issues with duplicate plugins, WS detection, preview support - no explicit regressions mentioned, mostly enhancements/fixes for nitro/vite integration.

Citations:


Consider using Nitro v2.13.2 (latest stable) or justify the v3 beta requirement.

Version 3.0.260311-beta is the latest v3 release, but v3 is still pre-release with breaking changes (package rename, import paths, Node.js v20 minimum, cloudflare env bindings). The latest stable release is Nitro v2.13.2. While the beta includes vite integration improvements (not regressions), using a pre-release in runtime dependencies is risky.

Either upgrade to v2.13.2 if compatible, or document why v3 is required and confirm your Vite/Nitro integration has been tested against this specific beta before release.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@packages/chronicle/package.json` at 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.

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.

1 participant