feat: import kaiden-docs as Docusaurus site with website styling#12
feat: import kaiden-docs as Docusaurus site with website styling#12slemeur wants to merge 9 commits into
Conversation
slemeur
commented
Jun 24, 2026
slemeur
commented
- Add docs/ directory (Docusaurus 3.10) with all 11 documentation pages
- Restyle docs to match openkaiden.ai design tokens (navy/sky-blue palette, DM Sans font, white content background, consistent dark mode colors)
- Update navbar: icon.png logo, matching height (64px), Website + GitHub links
- Fix Nav.svelte Docs link to point to docs.openkaiden.ai
- Fix schema.org URL in +page.svelte to openkaiden.ai
slemeur
force-pushed
the
initial-docs-import
branch
from
7511d8b to
b46b410
Compare
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 Walkthrough📝 Walkthrough🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
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: 7
🧹 Nitpick comments (1)
docs/src/css/custom.css (1)
259-261: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winAvoid styling via generated internal class names.
Selectors like
.sidebar_node_modules-\@docusaurus-...and.docMainContainer_node_modules-\@docusaurus-...are brittle across Docusaurus/theme updates. Prefer stable public theme selectors or swizzled component wrappers.Suggested direction
-.sidebar_node_modules-\`@docusaurus-theme-classic-lib-theme-DocSidebar-Desktop-Content-styles-module` { ... } -.sidebar_node_modules-\`@docusaurus-theme-classic-lib-theme-DocSidebar-Desktop-styles-module` { ... } -.docMainContainer_node_modules-\`@docusaurus-theme-classic-lib-theme-DocPage-Layout-Main-styles-module` { ... } +.theme-doc-sidebar-container { ... } +.theme-doc-sidebar-menu { ... } /* or other stable exported class hooks */ +.theme-doc-markdown, +.main-wrapper { ... } /* use stable layout hooks */Also applies to: 371-373, 603-605
🤖 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 `@docs/src/css/custom.css` around lines 259 - 261, Remove the brittle generated Docusaurus module class selectors from custom.css and replace them with stable theme-safe selectors or styles applied through swizzled wrapper components. Update the rules currently targeting sidebar and doc main container internals by locating the affected selectors in custom.css and rewriting them to use public theme classes or a wrapper class you control, so the styling does not depend on node_modules-generated names.
🤖 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 `@docs/content/core-concepts.md`:
- Around line 16-18: The markdown diagram fences in the core concepts document
are missing a language tag and should be updated to satisfy MD040. Update the
fenced blocks in this section, including the one showing Project → Sandbox →
Session and the other diagram block referenced by the comment, to use a text
fence (for example, the relevant markdown code block markers in the core
concepts content) so the diagrams are explicitly labeled.
In `@docs/content/settings.md`:
- Around line 95-98: The fenced block in the settings docs is missing a language
tag, triggering markdownlint MD040. Update the code fence that contains the kdn
and OpenShell entries to use an explicit language identifier (for example, text)
while keeping the existing content unchanged so the markdown renderer/linter
accepts it.
- Line 8: Update the Settings page introduction so it matches the actual
sections on the page: the current intro in the settings content mentions three
areas and “general preferences,” but only OpenShell and CLI Tools are
documented. Adjust the opening sentence in the settings markdown to reference
only the real sections, keeping the scope aligned with the documented headings
and avoiding mention of general preferences.
In `@docs/content/what-is-kaiden.md`:
- Around line 90-92: The fenced snippets in what-is-kaiden.md are missing a
language identifier, triggering MD040. Update both fenced blocks around the
Project → Sandbox → Session text and the Ready | Sandbox active... text to use
the text tag for these non-code examples, keeping the existing content
unchanged.
In `@docs/docusaurus.config.ts`:
- Around line 54-60: The navbar logo in the docusaurus config is still
configured at 32x32 instead of the required 64px size. Update the logo settings
in the logo block of the Docusaurus config so the icon uses a 64px height (and
matching width if needed), keeping the existing src, alt, and href unchanged.
In `@docs/package.json`:
- Line 2: The package metadata in docs/package.json uses an invalid npm name, so
update the name field to a real package identifier instead of ".". Change the
package name to something valid like docs or kaiden-docs, keeping the fix
localized to the package.json name entry so tooling that reads the metadata
works correctly.
In `@docs/src/pages/index.module.css`:
- Around line 26-29: The accent styles in the index.module.css module are
hardcoded with indigo values instead of the required navy/sky-blue token
palette, so update the accent-related rules to use the approved openkaiden.ai
tokens consistently across the module. Apply the same tokenized color approach
to the affected accent usages in the hero/badge/button/link styles and any other
matching selectors in this stylesheet so light and dark modes stay aligned with
branding.
---
Nitpick comments:
In `@docs/src/css/custom.css`:
- Around line 259-261: Remove the brittle generated Docusaurus module class
selectors from custom.css and replace them with stable theme-safe selectors or
styles applied through swizzled wrapper components. Update the rules currently
targeting sidebar and doc main container internals by locating the affected
selectors in custom.css and rewriting them to use public theme classes or a
wrapper class you control, so the styling does not depend on
node_modules-generated names.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6ef19f96-5b54-442a-a738-dc7d21a8fb8f
⛔ Files ignored due to path filters (36)
docs/content/assets/coding-agents.pngis excluded by!**/*.pngdocs/content/assets/knowledges.pngis excluded by!**/*.pngdocs/content/assets/mcp.pngis excluded by!**/*.pngdocs/content/assets/models-inhouse.pngis excluded by!**/*.pngdocs/content/assets/models-local.pngis excluded by!**/*.pngdocs/content/assets/models-semantic.pngis excluded by!**/*.pngdocs/content/assets/models.pngis excluded by!**/*.pngdocs/content/assets/new-workspace-agent.pngis excluded by!**/*.pngdocs/content/assets/new-workspace-filesystem.pngis excluded by!**/*.pngdocs/content/assets/new-workspace-network.pngis excluded by!**/*.pngdocs/content/assets/new-workspace-tools.pngis excluded by!**/*.pngdocs/content/assets/new-workspace.pngis excluded by!**/*.pngdocs/content/assets/overview.pngis excluded by!**/*.pngdocs/content/assets/project-detail.pngis excluded by!**/*.pngdocs/content/assets/projects.pngis excluded by!**/*.pngdocs/content/assets/sandboxes.pngis excluded by!**/*.pngdocs/content/assets/secret-add.pngis excluded by!**/*.pngdocs/content/assets/secrets.pngis excluded by!**/*.pngdocs/content/assets/settings-cli.pngis excluded by!**/*.pngdocs/content/assets/settings-experimental.pngis excluded by!**/*.pngdocs/content/assets/settings.pngis excluded by!**/*.pngdocs/content/assets/skills.pngis excluded by!**/*.pngdocs/content/assets/work.pngis excluded by!**/*.pngdocs/content/assets/workspace-detail-full.pngis excluded by!**/*.pngdocs/content/assets/workspace-detail.pngis excluded by!**/*.pngdocs/package-lock.jsonis excluded by!**/package-lock.jsondocs/static/img/docusaurus-social-card.jpgis excluded by!**/*.jpgdocs/static/img/docusaurus.pngis excluded by!**/*.pngdocs/static/img/favicon.icois excluded by!**/*.icodocs/static/img/icon.pngis excluded by!**/*.pngdocs/static/img/kaiden-logo-dark.svgis excluded by!**/*.svgdocs/static/img/kaiden-logo.svgis excluded by!**/*.svgdocs/static/img/logo.svgis excluded by!**/*.svgdocs/static/img/undraw_docusaurus_mountain.svgis excluded by!**/*.svgdocs/static/img/undraw_docusaurus_react.svgis excluded by!**/*.svgdocs/static/img/undraw_docusaurus_tree.svgis excluded by!**/*.svg
📒 Files selected for processing (26)
docs/.gitignoredocs/README.mddocs/content/ai-agents.mddocs/content/core-concepts.mddocs/content/credentials-and-secrets.mddocs/content/installation.mddocs/content/models-and-inference.mddocs/content/network-security.mddocs/content/projects.mddocs/content/settings.mddocs/content/skills-mcp-knowledge.mddocs/content/what-is-kaiden.mddocs/content/your-first-sandbox.mddocs/docusaurus.config.tsdocs/package.jsondocs/sidebars.tsdocs/src/components/HomepageFeatures/index.tsxdocs/src/components/HomepageFeatures/styles.module.cssdocs/src/css/custom.cssdocs/src/pages/index.module.cssdocs/src/pages/index.tsxdocs/src/pages/markdown-page.mdxdocs/static/.nojekylldocs/tsconfig.jsonsrc/lib/components/Nav.sveltesrc/routes/+page.svelte
| ``` | ||
| Project → Sandbox → Session | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Specify fence languages for diagram blocks.
These fenced blocks should include a language (use text) to satisfy MD040.
Suggested fix
-```
+```text
Project → Sandbox → Session@@
- +text
Project defaults
└─ Sandbox (inherits project, can override)
└─ Session (inherits sandbox)
Also applies to: 65-69
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 16-16: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@docs/content/core-concepts.md` around lines 16 - 18, The markdown diagram
fences in the core concepts document are missing a language tag and should be
updated to satisfy MD040. Update the fenced blocks in this section, including
the one showing Project → Sandbox → Session and the other diagram block
referenced by the comment, to use a text fence (for example, the relevant
markdown code block markers in the core concepts content) so the diagrams are
explicitly labeled.
Source: Linters/SAST tools
| sidebar_position: 9 | ||
| --- | ||
|
|
||
| The Settings section covers three areas: **OpenShell** (sandbox runtime), **CLI Tools**, and general preferences. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Align the intro scope with the actual page content.
Line 8 says this page covers three areas including “general preferences”, but the page only documents OpenShell and CLI Tools.
Suggested fix
-The Settings section covers three areas: **OpenShell** (sandbox runtime), **CLI Tools**, and general preferences.
+The Settings section covers two areas: **OpenShell** (sandbox runtime) and **CLI Tools**.📝 Committable suggestion
‼️ 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.
| The Settings section covers three areas: **OpenShell** (sandbox runtime), **CLI Tools**, and general preferences. | |
| The Settings section covers two areas: **OpenShell** (sandbox runtime) and **CLI Tools**. |
🤖 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 `@docs/content/settings.md` at line 8, Update the Settings page introduction so
it matches the actual sections on the page: the current intro in the settings
content mentions three areas and “general preferences,” but only OpenShell and
CLI Tools are documented. Adjust the opening sentence in the settings markdown
to reference only the real sections, keeping the scope aligned with the
documented headings and avoiding mention of general preferences.
| ``` | ||
| kdn v0.9.2 [Update] | ||
| OpenShell v2.1.0 [Update] | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add a language tag to the fenced code block.
Line 95 opens a fenced block without a language, which triggers markdownlint MD040.
Suggested fix
-```
+```text
kdn v0.9.2 [Update]
OpenShell v2.1.0 [Update]</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
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 95-95: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@docs/content/settings.md` around lines 95 - 98, The fenced block in the
settings docs is missing a language tag, triggering markdownlint MD040. Update
the code fence that contains the kdn and OpenShell entries to use an explicit
language identifier (for example, text) while keeping the existing content
unchanged so the markdown renderer/linter accepts it.
Source: Linters/SAST tools
| ``` | ||
| Project → Sandbox → Session | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add language identifiers to fenced code blocks.
Both fenced blocks are missing a language tag (MD040). Use text for these non-code snippets.
Suggested fix
-```
+```text
Project → Sandbox → Session@@
- +text
Ready | Sandbox active | ● OpenShell ▾ | OpenShift AI: Not connected
Also applies to: 112-114
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 90-90: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 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 `@docs/content/what-is-kaiden.md` around lines 90 - 92, The fenced snippets in
what-is-kaiden.md are missing a language identifier, triggering MD040. Update
both fenced blocks around the Project → Sandbox → Session text and the Ready |
Sandbox active... text to use the text tag for these non-code examples, keeping
the existing content unchanged.
Source: Linters/SAST tools
| @@ -0,0 +1,52 @@ | |||
| { | |||
| "name": ".", | |||
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major
🧩 Analysis chain
🌐 Web query:
Is "." a valid value for the namefield inpackage.json according to npm package naming rules?
💡 Result:
No, "." is not a valid value for the "name" field in a package.json file according to npm's official naming rules [1][2][3]. Under npm's requirements, package names must conform to several rules, and explicitly starting with a dot is prohibited for unscoped packages [1][2][4]. Specifically, the following constraints apply: 1. Leading Characters: Package names cannot begin with a dot (.) or an underscore (_) unless they are part of a scoped package (e.g., @scope/name) [1][2][3]. 2. URL Safety: The name must be URL-friendly, as it becomes part of a URL, a command-line argument, and a directory name [1][5][4]. 3. Length and Content: The name must be no more than 214 characters long and must not contain uppercase letters, spaces, or non-URL-safe characters [1][2][6][4]. While you can technically define a package.json file with any content if it is not intended to be published to the npm registry [1][6][7], npm's validation tools (such as validate-npm-package-name) will reject "." as a name because it violates these core naming conventions [4].
Citations:
- 1: https://courses.cs.washington.edu/courses/cse481v/21sp/projects/team1/node-v14.17.0-linux-x64/lib/node_modules/npm/docs/public/configuring-npm/package-json/
- 2: http://nodesource.com/blog/the-basics-of-package-json/
- 3: https://docs.npmjs.com/files/package.json/
- 4: https://github.com/npm/validate-npm-package-name
- 5: https://www.cs.hmc.edu/~jrosenbloom/FrontEndDevelopmentProject/NodeJS/node_modules/npm/html/doc/files/package.json.html
- 6: https://heynode.com/tutorial/what-packagejson/
- 7: Node.JS `package.json` parser rejects valid names with slashes (e.g. "rxjs/ajax") aquasecurity/trivy#10599
🏁 Script executed:
#!/bin/bash
set -euo pipefail
git ls-files docs/package.json
cat -n docs/package.json | sed -n '1,40p'Repository: openkaiden/website
Length of output: 1594
🏁 Script executed:
#!/bin/bash
set -euo pipefail
git ls-files docs/package.json
cat -n docs/package.json | sed -n '1,40p'Repository: openkaiden/website
Length of output: 1594
Use a valid package name in docs/package.json. "name": "." is not a valid npm package name and can confuse tooling that reads package metadata; replace it with a real name such as "docs" or "kaiden-docs".
🤖 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 `@docs/package.json` at line 2, The package metadata in docs/package.json uses
an invalid npm name, so update the name field to a real package identifier
instead of ".". Change the package name to something valid like docs or
kaiden-docs, keeping the fix localized to the package.json name entry so tooling
that reads the metadata works correctly.
| color: #6366f1; | ||
| background: rgba(99, 102, 241, 0.08); | ||
| border: 1px solid rgba(99, 102, 241, 0.2); | ||
| border-radius: 100px; |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Accent palette is not aligned to the required navy/sky-blue tokens.
These styles hardcode indigo values instead of using the openkaiden.ai token palette required by the PR objective, which can cause branding drift in both light/dark modes.
Suggested direction
-.primaryButton {
- background: `#6366f1`;
+.primaryButton {
+ background: var(--ifm-color-primary);
}
-.primaryButton:hover {
- background: `#4f46e5`;
+.primaryButton:hover {
+ background: var(--ifm-color-primary-dark);
}
-.cardIcon {
- color: `#6366f1`;
+.cardIcon {
+ color: var(--ifm-color-primary);
}Then apply the same tokenized approach to other accent usages in this module.
Also applies to: 72-85, 103-105, 178-179, 196-205
🤖 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 `@docs/src/pages/index.module.css` around lines 26 - 29, The accent styles in
the index.module.css module are hardcoded with indigo values instead of the
required navy/sky-blue token palette, so update the accent-related rules to use
the approved openkaiden.ai tokens consistently across the module. Apply the same
tokenized color approach to the affected accent usages in the
hero/badge/button/link styles and any other matching selectors in this
stylesheet so light and dark modes stay aligned with branding.
benoitf
left a comment
benoitf
left a comment
There was a problem hiding this comment.
need to do a cleanup in logos
here there are a log of docusaurus logos in the static folder that should not be there
|
the favicon is incorrect as well (docusaurus one) |
There was a problem hiding this comment.
♻️ Duplicate comments (4)
docs/content/settings.md (2)
8-8: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winAlign the intro scope with the actual page content.
Line 8 still says the page covers "three areas" including "general preferences," but only OpenShell and CLI Tools sections exist. The previous review suggestion was not applied.
Suggested fix
-The Settings section covers three areas: **OpenShell** (sandbox runtime), **CLI Tools**, and general preferences. +The Settings section covers two areas: **OpenShell** (sandbox runtime) and **CLI Tools**.🤖 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 `@docs/content/settings.md` at line 8, The Settings page intro is still describing a third “general preferences” area that does not exist. Update the opening sentence in the settings documentation to match the actual section structure by referencing only the existing OpenShell and CLI Tools sections, and keep the wording aligned with the page’s current content.
95-98: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winAdd a language tag to the fenced code block.
The version list block at lines 95-98 still lacks a language identifier (
MD040). The previous review suggestion was not applied.Suggested fix
+```text
kdn v0.9.2 [Update]
OpenShell v2.1.0 [Update]🤖 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 `@docs/content/settings.md` around lines 95 - 98, Add a language identifier to the fenced version list block in the settings docs to satisfy MD040. Update the markdown fence around the list containing kdn and OpenShell so it uses an explicit text-style tag, keeping the existing content unchanged and matching the prior review suggestion.docs/content/what-is-kaiden.md (2)
112-114: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winAdd language identifiers to fenced code blocks.
The status bar example block at lines 112-114 still lacks a language tag (
MD040). The previous review suggestion was not applied.Suggested fix
-``` +```text Ready | Sandbox active | ● OpenShell ▾ | OpenShift AI: Not connected</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@docs/content/what-is-kaiden.mdaround lines 112 - 114, The fenced status bar
example in the markdown content is missing a language identifier, which is still
triggering the MD040 lint issue. Update the code block around the status bar
example to use the appropriate fenced code block tag, using the existing example
text and keeping the snippet in the same location so the markdown linter
recognizes it correctly.</details> <!-- cr-comment:v1:1fa1c973ebdbdef42cdb7a86 --> --- `90-92`: _📐 Maintainability & Code Quality_ | _🟡 Minor_ | _⚡ Quick win_ **Add language identifiers to fenced code blocks.** The `Project → Sandbox → Session` block at lines 90-92 still lacks a language tag (`MD040`). The previous review suggestion was not applied. <details> <summary>Suggested fix</summary> ```diff -``` +```text Project → Sandbox → Session</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.In
@docs/content/what-is-kaiden.mdaround lines 90 - 92, Add a language
identifier to the fenced code block so it satisfies MD040; update the existing
block around the “Project → Sandbox → Session” example to use an appropriate
fence tag (such as text) in the markdown content, keeping the block’s content
unchanged. Locate the fenced block in the what-is-kaiden document and apply the
fix to the markdown fence itself rather than the displayed text.</details> <!-- cr-comment:v1:43ff9921a0464d683133d217 --> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.Duplicate comments:
In@docs/content/settings.md:
- Line 8: The Settings page intro is still describing a third “general
preferences” area that does not exist. Update the opening sentence in the
settings documentation to match the actual section structure by referencing only
the existing OpenShell and CLI Tools sections, and keep the wording aligned with
the page’s current content.- Around line 95-98: Add a language identifier to the fenced version list block
in the settings docs to satisfy MD040. Update the markdown fence around the list
containing kdn and OpenShell so it uses an explicit text-style tag, keeping the
existing content unchanged and matching the prior review suggestion.In
@docs/content/what-is-kaiden.md:
- Around line 112-114: The fenced status bar example in the markdown content is
missing a language identifier, which is still triggering the MD040 lint issue.
Update the code block around the status bar example to use the appropriate
fenced code block tag, using the existing example text and keeping the snippet
in the same location so the markdown linter recognizes it correctly.- Around line 90-92: Add a language identifier to the fenced code block so it
satisfies MD040; update the existing block around the “Project → Sandbox →
Session” example to use an appropriate fence tag (such as text) in the markdown
content, keeping the block’s content unchanged. Locate the fenced block in the
what-is-kaiden document and apply the fix to the markdown fence itself rather
than the displayed text.</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Organization UI **Review profile**: CHILL **Plan**: Pro **Run ID**: `b17de542-695a-4af0-851d-55f1befcb20c` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 7511d8b50a736c45ed132a422684070efd17519c and 8030b08ec1c420b9b17a7287e0de0d8922576859. </details> <details> <summary>⛔ Files ignored due to path filters (30)</summary> * `docs/content/assets/coding-agents.png` is excluded by `!**/*.png` * `docs/content/assets/knowledges.png` is excluded by `!**/*.png` * `docs/content/assets/mcp.png` is excluded by `!**/*.png` * `docs/content/assets/models-inhouse.png` is excluded by `!**/*.png` * `docs/content/assets/models-local.png` is excluded by `!**/*.png` * `docs/content/assets/models-semantic.png` is excluded by `!**/*.png` * `docs/content/assets/models.png` is excluded by `!**/*.png` * `docs/content/assets/new-workspace-agent.png` is excluded by `!**/*.png` * `docs/content/assets/new-workspace-filesystem.png` is excluded by `!**/*.png` * `docs/content/assets/new-workspace-network.png` is excluded by `!**/*.png` * `docs/content/assets/new-workspace-tools.png` is excluded by `!**/*.png` * `docs/content/assets/new-workspace.png` is excluded by `!**/*.png` * `docs/content/assets/overview.png` is excluded by `!**/*.png` * `docs/content/assets/project-detail.png` is excluded by `!**/*.png` * `docs/content/assets/projects.png` is excluded by `!**/*.png` * `docs/content/assets/sandboxes.png` is excluded by `!**/*.png` * `docs/content/assets/secret-add.png` is excluded by `!**/*.png` * `docs/content/assets/secrets.png` is excluded by `!**/*.png` * `docs/content/assets/settings-cli.png` is excluded by `!**/*.png` * `docs/content/assets/settings-experimental.png` is excluded by `!**/*.png` * `docs/content/assets/settings.png` is excluded by `!**/*.png` * `docs/content/assets/skills.png` is excluded by `!**/*.png` * `docs/content/assets/work.png` is excluded by `!**/*.png` * `docs/content/assets/workspace-detail-full.png` is excluded by `!**/*.png` * `docs/content/assets/workspace-detail.png` is excluded by `!**/*.png` * `docs/package-lock.json` is excluded by `!**/package-lock.json` * `docs/static/img/favicon.ico` is excluded by `!**/*.ico` * `docs/static/img/icon.png` is excluded by `!**/*.png` * `docs/static/img/kaiden-logo-dark.svg` is excluded by `!**/*.svg` * `docs/static/img/kaiden-logo.svg` is excluded by `!**/*.svg` </details> <details> <summary>📒 Files selected for processing (23)</summary> * `docs/.gitignore` * `docs/README.md` * `docs/content/ai-agents.md` * `docs/content/core-concepts.md` * `docs/content/credentials-and-secrets.md` * `docs/content/installation.md` * `docs/content/models-and-inference.md` * `docs/content/network-security.md` * `docs/content/projects.md` * `docs/content/settings.md` * `docs/content/skills-mcp-knowledge.md` * `docs/content/what-is-kaiden.md` * `docs/content/your-first-sandbox.md` * `docs/docusaurus.config.ts` * `docs/package.json` * `docs/sidebars.ts` * `docs/src/css/custom.css` * `docs/src/pages/index.module.css` * `docs/src/pages/index.tsx` * `docs/static/.nojekyll` * `docs/tsconfig.json` * `src/lib/components/Nav.svelte` * `src/routes/+page.svelte` </details> <details> <summary>✅ Files skipped from review due to trivial changes (9)</summary> * docs/.gitignore * docs/sidebars.ts * src/routes/+page.svelte * docs/README.md * docs/content/ai-agents.md * docs/content/skills-mcp-knowledge.md * docs/content/network-security.md * docs/content/models-and-inference.md * docs/content/your-first-sandbox.md </details> <details> <summary>🚧 Files skipped from review as they are similar to previous changes (8)</summary> * docs/content/installation.md * src/lib/components/Nav.svelte * docs/tsconfig.json * docs/package.json * docs/src/pages/index.module.css * docs/src/pages/index.tsx * docs/docusaurus.config.ts * docs/src/css/custom.css </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
- Add docs/ directory (Docusaurus 3.10) with all 11 documentation pages - Restyle docs to match openkaiden.ai design tokens (navy/sky-blue palette, DM Sans font, white content background, consistent dark mode colors) - Update navbar: icon.png logo, matching height (64px), Website + GitHub links - Fix Nav.svelte Docs link to point to docs.openkaiden.ai - Fix schema.org URL in +page.svelte to openkaiden.ai Signed-off-by: Stevan Le Meur <[email protected]> Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
- Delete HomepageFeatures component (unused Docusaurus template) - Delete markdown-page.mdx sample page - Delete default Docusaurus images and placeholder illustrations - Replace README with Kaiden-specific content Signed-off-by: Stevan Le Meur <[email protected]> Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Signed-off-by: Stevan Le Meur <[email protected]> Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Signed-off-by: Stevan Le Meur <[email protected]> Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
benoitf
force-pushed
the
initial-docs-import
branch
from
91d82f9 to
d664679
Compare
- Set url to https://openkaiden.ai and baseUrl to /docs/ - Set routeBasePath to / to avoid /docs/docs/ double prefix - Update all internal doc links accordingly - Update Nav.svelte Docs link to openkaiden.ai/docs Signed-off-by: Stevan Le Meur <[email protected]> Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Update the root build script to run the Docusaurus build after SvelteKit and copy docs/build/ into build/docs/ so Cloudflare Pages serves the docs at /docs. Switch all internal navigation links (Nav.svelte Docs link, Docusaurus logo, Website navbar item) from absolute URLs to relative paths. Signed-off-by: Stevan Le Meur <[email protected]> Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
SvelteKit's prerenderer follows links found in the built pages. The /docs link in Nav.svelte caused a 404 during vite build because Docusaurus isn't built yet at that point. Add handleHttpError to suppress 404s on /docs/* paths (they're served by Docusaurus, not SvelteKit). Also switch npm ci to npm install for the docs sub-build to avoid ENOTEMPTY failures when node_modules already exists, and add mkdir -p before the cp to ensure the target directory exists. Signed-off-by: Stevan Le Meur <[email protected]> Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
slemeur
force-pushed
the
initial-docs-import
branch
from
dbee211 to
134665f
Compare
…nalytics Replace Docusaurus built-in footer with a custom component (src/theme/Footer) that mirrors the main website footer: brand section with icon and description, Project and Organization link columns, and consistent typography using the same CSS variables as the rest of the docs. Also: - Set title to "Kaiden Documentation" - Add docusaurus-plugin-goatcounter wired to the openkaiden-website account - Remove the footer themeConfig block (replaced by the custom component) Signed-off-by: Stevan Le Meur <[email protected]> Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
- Set navbar title to 'kaiden' (lowercase, matching the website wordmark) - Remove the docSidebar left nav item — sidebar provides in-page navigation, the top nav no longer duplicates it - Reorder right items to match website: GitHub icon first, then Website link - Remove duplicate .navbar__brand CSS rule Signed-off-by: Stevan Le Meur <[email protected]> Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
2 participants
