-
-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add docs site and refresh landing #122
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
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
d2b4457
feat: add docs site and refresh landing
ian-pascoe 9a322e3
chore: add changeset for remote attach updates
ian-pascoe 0f0d2b4
fix: address PR review feedback
ian-pascoe 89e8a47
fix: route allowed direct-tool shadows locally
ian-pascoe 321ca6b
fix: align outside-diff review feedback
ian-pascoe 289764c
fix: address attach review feedback
ian-pascoe ccd6111
fix(landing+docs): impeccable audit/critique fixes
ian-pascoe fd0920e
fix: address docs review feedback
ian-pascoe 387a2be
fix: address shadowing review feedback
ian-pascoe 324a164
fix: address docs setup review feedback
ian-pascoe File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@caplets/core": minor | ||
| --- | ||
|
|
||
| Add remote attach URL configuration and update the native remote attach flow. |
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # build output | ||
| dist/ | ||
| # generated types | ||
| .astro/ | ||
|
|
||
| # dependencies | ||
| node_modules/ | ||
|
|
||
| # logs | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
| pnpm-debug.log* | ||
|
|
||
|
|
||
| # environment variables | ||
| .env | ||
| .env.production | ||
|
|
||
| # macOS-specific files | ||
| .DS_Store |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Caplets Docs | ||
|
|
||
| Astro Starlight documentation site for [docs.caplets.dev](https://docs.caplets.dev). | ||
|
|
||
| Public docs live in `apps/docs/src/content/docs`. Root `docs/` is internal maintainer | ||
| documentation and is not routed into this site. | ||
|
|
||
| Generated reference pages and the public changelog come from: | ||
|
|
||
| - `schemas/caplets-config.schema.json` | ||
| - `schemas/caplet.schema.json` | ||
| - `packages/core/src/code-mode/runtime-api.d.ts` | ||
| - `CHANGELOG.md` | ||
|
|
||
| ## Commands | ||
|
|
||
| Run from the repository root: | ||
|
|
||
| ```sh | ||
| pnpm docs:generate | ||
| pnpm docs:check | ||
| pnpm --filter @caplets/docs dev -- --port 4322 | ||
| pnpm --filter @caplets/docs typecheck | ||
| pnpm --filter @caplets/docs build | ||
| ``` |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| // @ts-check | ||
| import starlight from "@astrojs/starlight"; | ||
| import tailwindcss from "@tailwindcss/vite"; | ||
| import { defineConfig } from "astro/config"; | ||
|
|
||
| export default defineConfig({ | ||
| site: "https://docs.caplets.dev", | ||
| integrations: [ | ||
| starlight({ | ||
| title: "Caplets Docs", | ||
| logo: { | ||
| src: "./src/assets/caplets-icon.png", | ||
| alt: "Caplets", | ||
| }, | ||
| social: [ | ||
| { | ||
| icon: "github", | ||
| label: "GitHub", | ||
| href: "https://github.com/spiritledsoftware/caplets", | ||
| }, | ||
| ], | ||
| customCss: ["./src/styles/global.css"], | ||
| components: { | ||
| ThemeProvider: "./src/components/CapletsThemeProvider.astro", | ||
| ThemeSelect: "./src/components/CapletsThemeSelect.astro", | ||
| }, | ||
| editLink: { | ||
| baseUrl: "https://github.com/spiritledsoftware/caplets/edit/main/apps/docs/", | ||
| }, | ||
| sidebar: [ | ||
| { | ||
| label: "Get Started", | ||
| items: [ | ||
| { label: "Start here", link: "/" }, | ||
| { label: "Install", link: "/install/" }, | ||
| { label: "Configuration", link: "/configuration/" }, | ||
| ], | ||
| }, | ||
| { | ||
| label: "Use Caplets", | ||
| items: [ | ||
| { label: "Code Mode", link: "/code-mode/" }, | ||
| { label: "Add capabilities", link: "/capabilities/" }, | ||
| { label: "Agent integrations", link: "/agent-integrations/" }, | ||
| { label: "Remote attach", link: "/remote-attach/" }, | ||
| { label: "Troubleshooting", link: "/troubleshooting/" }, | ||
| ], | ||
| }, | ||
| { | ||
| label: "Reference", | ||
| items: [ | ||
| { label: "Configuration schema", link: "/reference/config/" }, | ||
| { label: "Code Mode API", link: "/reference/code-mode-api/" }, | ||
| { label: "Caplet files", link: "/reference/caplet-files/" }, | ||
| { label: "Changelog", link: "/changelog/" }, | ||
| ], | ||
| }, | ||
| ], | ||
| }), | ||
| ], | ||
| vite: { | ||
| plugins: [tailwindcss()], | ||
| }, | ||
| }); |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| { | ||
| "name": "@caplets/docs", | ||
| "version": "0.1.0", | ||
| "private": true, | ||
| "type": "module", | ||
| "scripts": { | ||
| "astro": "astro", | ||
| "build": "astro build", | ||
| "dev": "astro dev", | ||
| "preview": "astro preview", | ||
| "typecheck": "astro check" | ||
| }, | ||
| "dependencies": { | ||
| "@astrojs/check": "^0.9.9", | ||
| "@astrojs/starlight": "^0.40.0", | ||
| "@tailwindcss/vite": "^4.3.1", | ||
| "astro": "^6.4.6", | ||
| "sharp": "^0.34.5", | ||
| "tailwindcss": "^4.3.1", | ||
| "typescript": "^6.0.3" | ||
| }, | ||
| "devDependencies": { | ||
| "vite": "^7.3.5" | ||
| }, | ||
| "engines": { | ||
| "node": ">=24" | ||
| } | ||
| } |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| {/* This is intentionally inlined to avoid FOUC. */} | ||
| <script is:inline> | ||
| window.StarlightThemeProvider = (() => { | ||
| const storedTheme = | ||
| typeof localStorage !== "undefined" && localStorage.getItem("starlight-theme"); | ||
| const parseTheme = (theme) => | ||
| theme === "dark" || theme === "auto" || theme === "light" ? theme : "light"; | ||
| const theme = parseTheme(storedTheme); | ||
| const resolvedTheme = | ||
| theme === "auto" | ||
| ? window.matchMedia("(prefers-color-scheme: light)").matches | ||
| ? "light" | ||
| : "dark" | ||
| : theme; | ||
| document.documentElement.dataset.theme = resolvedTheme; | ||
| return { | ||
| updatePickers(theme = storedTheme || "light") { | ||
| theme = parseTheme(theme); | ||
| document.querySelectorAll("starlight-theme-select").forEach((picker) => { | ||
| const select = picker.querySelector("select"); | ||
| if (select) select.value = theme; | ||
| /** @type {HTMLTemplateElement | null} */ | ||
| const tmpl = document.querySelector(`#theme-icons`); | ||
| const newIcon = tmpl && tmpl.content.querySelector("." + theme); | ||
| if (newIcon) { | ||
| const oldIcon = picker.querySelector("svg.label-icon"); | ||
| if (oldIcon) { | ||
| oldIcon.replaceChildren(...newIcon.cloneNode(true).childNodes); | ||
| } | ||
| } | ||
| }); | ||
| }, | ||
| }; | ||
| })(); | ||
| </script> | ||
|
|
||
| <template id="theme-icons"> | ||
| <svg aria-hidden="true" class="light" width="16" height="16" viewBox="0 0 24 24" fill="currentColor"> | ||
| <path | ||
| d="M5 12a1 1 0 0 0-1-1H3a1 1 0 0 0 0 2h1a1 1 0 0 0 1-1Zm.64 5-.71.71a1 1 0 0 0 1.41 1.41l.71-.71A1 1 0 0 0 5.64 17ZM12 5a1 1 0 0 0 1-1V3a1 1 0 0 0-2 0v1a1 1 0 0 0 1 1Zm5.66 2.34a1 1 0 0 0 .7-.29l.71-.71a1 1 0 1 0-1.41-1.41l-.66.71a1 1 0 0 0 0 1.41 1 1 0 0 0 .66.29ZM21 11h-1a1 1 0 0 0 0 2h1a1 1 0 0 0 0-2Zm-9 7.5a1 1 0 0 0-1 1V21a1 1 0 0 0 2 0v-1.5a1 1 0 0 0-1-1ZM12 7a5 5 0 1 0 0 10 5 5 0 0 0 0-10Z" | ||
| /> | ||
| </svg> | ||
| <svg aria-hidden="true" class="dark" width="16" height="16" viewBox="0 0 24 24" fill="currentColor"> | ||
| <path | ||
| d="M21.64 13a1 1 0 0 0-1.05-.14 8.05 8.05 0 0 1-3.37.73 8.15 8.15 0 0 1-8.14-8.1 8.6 8.6 0 0 1 .25-2A1 1 0 0 0 8 2.36a10.14 10.14 0 1 0 14 11.69 1 1 0 0 0-.36-1.05Z" | ||
| /> | ||
| </svg> | ||
| <svg aria-hidden="true" class="auto" width="16" height="16" viewBox="0 0 24 24" fill="currentColor"> | ||
| <path | ||
| d="M21 14h-1V7a3 3 0 0 0-3-3H7a3 3 0 0 0-3 3v7H3a1 1 0 0 0-1 1v2a3 3 0 0 0 3 3h14a3 3 0 0 0 3-3v-2a1 1 0 0 0-1-1ZM6 7a1 1 0 0 1 1-1h10a1 1 0 0 1 1 1v7H6V7Zm14 10a1 1 0 0 1-1 1H5a1 1 0 0 1-1-1v-1h16v1Z" | ||
| /> | ||
| </svg> | ||
| </template> | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.