-
Notifications
You must be signed in to change notification settings - Fork 0
feat: update docs and add vercel.json #25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
161311a
5e61673
ba49b04
e0b4e2e
f3ef000
190588d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -134,4 +134,6 @@ dist | |
| .pnp.* | ||
|
|
||
| dist | ||
| .output/ | ||
| .vercel/ | ||
| examples/frontier | ||
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,6 +78,14 @@ icon: rectangle-stack | |
| | `method-delete` | HTTP DELETE badge | | ||
| | `method-patch` | HTTP PATCH badge | | ||
|
|
||
| ### lastModified | ||
|
|
||
| Optional date string indicating when the page was last updated. | ||
|
|
||
| ```yaml | ||
| lastModified: "2026-03-30" | ||
| ``` | ||
|
Comment on lines
+83
to
+87
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
“Optional date string” is too broad. Since sitemap generation converts this value with ✏️ 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"🤖 Prompt for AI Agents |
||
|
|
||
| ## Navigation Ordering | ||
|
|
||
| Sidebar navigation is determined by: | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,15 @@ | ||
| { | ||
| "name": "chronicle", | ||
| "private": true, | ||
| "workspaces": ["packages/*", "examples/*"], | ||
| "workspaces": [ | ||
| "packages/*", | ||
| "examples/*" | ||
| ], | ||
| "engines": { | ||
| "node": ">=22" | ||
| }, | ||
| "scripts": { | ||
| "build:cli": "bun run --filter @raystack/chronicle build:cli", | ||
| "build:docs": "./packages/chronicle/bin/chronicle.js build --content docs" | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -51,7 +51,7 @@ | |
| "lodash": "^4.17.23", | ||
| "mermaid": "^11.13.0", | ||
| "minisearch": "^7.2.0", | ||
| "nitro": "latest", | ||
| "nitro": "3.0.260311-beta", | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🧩 Analysis chain🌐 Web query:
💡 Result: In version 3.0.260311-beta of Nitro (nitrojs/nitro), key changes include: 🚀 Enhancements: - Export http utils from nitro ( 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 |
||
| "openapi-types": "^12.1.3", | ||
| "react": "^19.0.0", | ||
| "react-dom": "^19.0.0", | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "installCommand": "bun install", | ||
| "buildCommand": "bun run build:cli && bun run build:docs -- --preset vercel", | ||
| "outputDirectory": ".vercel/output" | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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