From 311ec8b28b83d5d0465927870f0a7f0f180f895c Mon Sep 17 00:00:00 2001 From: ninjeeter Date: Mon, 13 Jul 2026 07:24:13 -0700 Subject: [PATCH 1/5] Get Started button - ready for review. --- src/index.md | 3 +++ src/quickstart.md | 23 +++++++++++++++++++++++ 2 files changed, 26 insertions(+) create mode 100644 src/quickstart.md diff --git a/src/index.md b/src/index.md index 46e86ef..a1e5f77 100644 --- a/src/index.md +++ b/src/index.md @@ -11,6 +11,9 @@ hero: tagline: Developer Documentation actions: + - theme: brand + text: Get Started + link: /quickstart.md - theme: alt text: Plugins link: /plugins/guides/ diff --git a/src/quickstart.md b/src/quickstart.md new file mode 100644 index 0000000..40422c1 --- /dev/null +++ b/src/quickstart.md @@ -0,0 +1,23 @@ +# Welcome to the Caido Developer Documentation! + +Here, you will find a wealth of information and resources for the [Software Development Kits (SDKs)](https://en.wikipedia.org/wiki/Software_development_kit) offered by Caido. + +## Plugins + +For users looking to customize/extend Caido's functionality, the [@caido/sdk-frontend](/plugins/reference/sdks/frontend/), [@caido/sdk-backend](/plugins/reference/sdks/backend/) kits provide the components and features for creating your own custom plugins. + +::: tip +View the [Getting Started](/plugins/guides/) guide to learn how to create your own Caido plugin. +::: + +The [@caido/sdk-workflow](/plugins/reference/sdks/workflow/) kit provides the interface for working with Caido data [using the JavaScript node](https://docs.caido.io/app/guides/workflows_javascript.html) in workflows. + +For both plugins and workflows, a number of [modules](/plugins/reference/modules/) are supported for Caido’s QuickJS JavaScript engine. + +## Client SDK + +The [@caido/sdk-client](http://localhost:5173/client-sdk/reference/) kit provides an interface for programmatic access to a running Caido instance from external scripts and tools. + +::: tip +View the [Install the SDK](/client-sdk/guides/install.md) guide to get started. +::: \ No newline at end of file From a3fff94607b3dc91deff3b60ce02df88597863f2 Mon Sep 17 00:00:00 2001 From: ninjeeter Date: Mon, 13 Jul 2026 07:29:26 -0700 Subject: [PATCH 2/5] Fix link. --- src/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/quickstart.md b/src/quickstart.md index 40422c1..77c86dc 100644 --- a/src/quickstart.md +++ b/src/quickstart.md @@ -16,7 +16,7 @@ For both plugins and workflows, a number of [modules](/plugins/reference/modules ## Client SDK -The [@caido/sdk-client](http://localhost:5173/client-sdk/reference/) kit provides an interface for programmatic access to a running Caido instance from external scripts and tools. +The [@caido/sdk-client](/client-sdk/reference/) kit provides an interface for programmatic access to a running Caido instance from external scripts and tools. ::: tip View the [Install the SDK](/client-sdk/guides/install.md) guide to get started. From 257af7c8b7159b4127b55ca039947a0f8167d299 Mon Sep 17 00:00:00 2001 From: ninjeeter Date: Mon, 13 Jul 2026 07:30:25 -0700 Subject: [PATCH 3/5] Route path. --- src/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/index.md b/src/index.md index a1e5f77..fb48ed7 100644 --- a/src/index.md +++ b/src/index.md @@ -13,7 +13,7 @@ hero: actions: - theme: brand text: Get Started - link: /quickstart.md + link: /quickstart - theme: alt text: Plugins link: /plugins/guides/ From 7021cb1e88042477a4ca1841cc34ff0b88e827e7 Mon Sep 17 00:00:00 2001 From: ninjeeter Date: Mon, 13 Jul 2026 08:14:38 -0700 Subject: [PATCH 4/5] Button contrast --- .vitepress/theme/custom.css | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.vitepress/theme/custom.css b/.vitepress/theme/custom.css index 441b29e..d45751c 100644 --- a/.vitepress/theme/custom.css +++ b/.vitepress/theme/custom.css @@ -3,7 +3,9 @@ --vp-c-brand-2: #95D2B3; --vp-c-brand-3: #D8EFD3; - --vp-button-brand-active-bg: var(--vp-c-brand-3); + --vp-button-brand-bg: var(--vp-c-brand-1); + --vp-button-brand-hover-bg: var(--vp-c-brand-2); + --vp-button-brand-active-bg: var(--vp-c-brand-1); } From d745097af10ecf2426b3ba055ca94731c2cf5e73 Mon Sep 17 00:00:00 2001 From: ninjeeter Date: Mon, 13 Jul 2026 08:21:04 -0700 Subject: [PATCH 5/5] Get Started topnav --- .vitepress/config.mts | 15 ++++++++++++++- .vitepress/navbars/index.ts | 1 + .vitepress/navbars/quickstart.ts | 5 +++++ 3 files changed, 20 insertions(+), 1 deletion(-) create mode 100644 .vitepress/navbars/quickstart.ts diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 9620bec..fb25d95 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -3,7 +3,11 @@ import llmstxt from "vitepress-plugin-llms"; import type { DefaultTheme } from "vitepress"; -import { clientSdkNavbar, pluginsNavbar } from "./navbars"; +import { + clientSdkNavbar, + pluginsNavbar, + quickstartNavbar, +} from "./navbars"; import { clientSdkSidebars, pluginsSidebars } from "./sidebars"; // https://vitepress.dev/reference/site-config @@ -47,6 +51,15 @@ export default defineConfig({ }, nav: [ + { + component: "NavItem", + props: { + text: "Get Started", + link: "/quickstart/", + activeMatch: "^/quickstart(/|$)", + items: quickstartNavbar, + }, + }, { component: "NavItem", props: { diff --git a/.vitepress/navbars/index.ts b/.vitepress/navbars/index.ts index 5c9d9ae..7fc6784 100644 --- a/.vitepress/navbars/index.ts +++ b/.vitepress/navbars/index.ts @@ -1,2 +1,3 @@ export * from "./plugins"; export * from "./client-sdk"; +export * from "./quickstart"; \ No newline at end of file diff --git a/.vitepress/navbars/quickstart.ts b/.vitepress/navbars/quickstart.ts new file mode 100644 index 0000000..2831b2d --- /dev/null +++ b/.vitepress/navbars/quickstart.ts @@ -0,0 +1,5 @@ +import type { DefaultTheme } from "vitepress"; + +export const quickstartNavbar: DefaultTheme.NavItemWithLink[] = [ + { text: "Get Started", link: "/quickstart/" }, +]; \ No newline at end of file