From 97ab4998244bfbbed0c0d40cb1dc1462fb6ad56d Mon Sep 17 00:00:00 2001 From: Brendan O'Leary Date: Tue, 27 Jan 2026 07:36:16 +0100 Subject: [PATCH] Add customize section to break up code with ai --- packages/kilo-docs/components/SideNav.tsx | 2 + packages/kilo-docs/components/TopNav.tsx | 1 + packages/kilo-docs/lib/nav/code-with-ai.ts | 38 -------- packages/kilo-docs/lib/nav/customize.ts | 43 ++++++++++ packages/kilo-docs/lib/nav/index.ts | 2 + packages/kilo-docs/next-env.d.ts | 2 +- .../kilo-docs/pages/code-with-ai/index.md | 36 ++------ .../customization => customize}/agents-md.md | 0 .../context/codebase-indexing.md | 0 .../context/large-projects.md | 0 .../context/memory-bank.md | 0 .../custom-instructions.md | 0 .../custom-modes.md | 0 .../custom-rules.md | 0 packages/kilo-docs/pages/customize/index.md | 51 +++++++++++ .../prompt-engineering.md | 0 .../customization => customize}/skills.md | 0 .../customization => customize}/workflows.md | 0 packages/kilo-docs/previous-docs-redirects.js | 86 ++++++++++++++++--- 19 files changed, 180 insertions(+), 81 deletions(-) create mode 100644 packages/kilo-docs/lib/nav/customize.ts rename packages/kilo-docs/pages/{code-with-ai/customization => customize}/agents-md.md (100%) rename packages/kilo-docs/pages/{code-with-ai => customize}/context/codebase-indexing.md (100%) rename packages/kilo-docs/pages/{code-with-ai => customize}/context/large-projects.md (100%) rename packages/kilo-docs/pages/{code-with-ai => customize}/context/memory-bank.md (100%) rename packages/kilo-docs/pages/{code-with-ai/customization => customize}/custom-instructions.md (100%) rename packages/kilo-docs/pages/{code-with-ai/customization => customize}/custom-modes.md (100%) rename packages/kilo-docs/pages/{code-with-ai/customization => customize}/custom-rules.md (100%) create mode 100644 packages/kilo-docs/pages/customize/index.md rename packages/kilo-docs/pages/{code-with-ai/customization => customize}/prompt-engineering.md (100%) rename packages/kilo-docs/pages/{code-with-ai/customization => customize}/skills.md (100%) rename packages/kilo-docs/pages/{code-with-ai/customization => customize}/workflows.md (100%) diff --git a/packages/kilo-docs/components/SideNav.tsx b/packages/kilo-docs/components/SideNav.tsx index effb24afc6d..ca3b7cef086 100644 --- a/packages/kilo-docs/components/SideNav.tsx +++ b/packages/kilo-docs/components/SideNav.tsx @@ -8,6 +8,7 @@ import { Nav } from "../lib/nav" const sectionNavItems: SectionNav = { "getting-started": Nav.GettingStartedNav, "code-with-ai": Nav.CodeWithAiNav, + customize: Nav.CustomizeNav, collaborate: Nav.CollaborateNav, "automate/tools": Nav.ToolsNav, automate: Nav.AutomateNav, @@ -21,6 +22,7 @@ const mainNavItems = [ { label: "Home", href: "/", sectionKey: null }, { label: "Get Started", href: "/getting-started", sectionKey: "getting-started" }, { label: "Code with AI", href: "/code-with-ai", sectionKey: "code-with-ai" }, + { label: "Customize", href: "/customize", sectionKey: "customize" }, { label: "Collaborate", href: "/collaborate", sectionKey: "collaborate" }, { label: "Automate", href: "/automate", sectionKey: "automate" }, { label: "Deploy & Secure", href: "/deploy-secure", sectionKey: "deploy-secure" }, diff --git a/packages/kilo-docs/components/TopNav.tsx b/packages/kilo-docs/components/TopNav.tsx index bfc03205d0f..749163330d5 100644 --- a/packages/kilo-docs/components/TopNav.tsx +++ b/packages/kilo-docs/components/TopNav.tsx @@ -26,6 +26,7 @@ interface DropdownMenuProps { const mainNavItems: NavItem[] = [ { label: "Get Started", href: "/getting-started" }, { label: "Code with AI", href: "/code-with-ai" }, + { label: "Customize", href: "/customize" }, { label: "Collaborate", href: "/collaborate" }, { label: "Automate", href: "/automate" }, { label: "Deploy & Secure", href: "/deploy-secure" }, diff --git a/packages/kilo-docs/lib/nav/code-with-ai.ts b/packages/kilo-docs/lib/nav/code-with-ai.ts index 142ced0d9ff..20b7ad9fe84 100644 --- a/packages/kilo-docs/lib/nav/code-with-ai.ts +++ b/packages/kilo-docs/lib/nav/code-with-ai.ts @@ -65,42 +65,4 @@ export const CodeWithAiNav: NavSection[] = [ }, ], }, - { - title: "Customization", - links: [ - { - href: "/code-with-ai/customization/custom-modes", - children: "Custom Modes", - }, - { - href: "/code-with-ai/customization/custom-rules", - children: "Custom Rules", - }, - { - href: "/code-with-ai/customization/custom-instructions", - children: "Custom Instructions", - }, - { href: "/code-with-ai/customization/agents-md", children: "agents.md" }, - { href: "/code-with-ai/customization/workflows", children: "Workflows" }, - { href: "/code-with-ai/customization/skills", children: "Skills" }, - { - href: "/code-with-ai/customization/prompt-engineering", - children: "Prompt Engineering", - }, - ], - }, - { - title: "Context & Indexing", - links: [ - { - href: "/code-with-ai/context/codebase-indexing", - children: "Codebase Indexing", - }, - { href: "/code-with-ai/context/memory-bank", children: "Memory Bank" }, - { - href: "/code-with-ai/context/large-projects", - children: "Large Projects", - }, - ], - }, ] diff --git a/packages/kilo-docs/lib/nav/customize.ts b/packages/kilo-docs/lib/nav/customize.ts new file mode 100644 index 00000000000..44e33c89721 --- /dev/null +++ b/packages/kilo-docs/lib/nav/customize.ts @@ -0,0 +1,43 @@ +import { NavSection } from "../types" + +export const CustomizeNav: NavSection[] = [ + { + title: "Customization", + links: [ + { href: "/customize", children: "Overview" }, + { + href: "/customize/custom-modes", + children: "Custom Modes", + }, + { + href: "/customize/custom-rules", + children: "Custom Rules", + }, + { + href: "/customize/custom-instructions", + children: "Custom Instructions", + }, + { href: "/customize/agents-md", children: "agents.md" }, + { href: "/customize/workflows", children: "Workflows" }, + { href: "/customize/skills", children: "Skills" }, + { + href: "/customize/prompt-engineering", + children: "Prompt Engineering", + }, + ], + }, + { + title: "Context & Indexing", + links: [ + { + href: "/customize/context/codebase-indexing", + children: "Codebase Indexing", + }, + { href: "/customize/context/memory-bank", children: "Memory Bank" }, + { + href: "/customize/context/large-projects", + children: "Large Projects", + }, + ], + }, +] diff --git a/packages/kilo-docs/lib/nav/index.ts b/packages/kilo-docs/lib/nav/index.ts index d59928f1d23..2479ddd96b5 100644 --- a/packages/kilo-docs/lib/nav/index.ts +++ b/packages/kilo-docs/lib/nav/index.ts @@ -3,6 +3,7 @@ import { AutomateNav } from "./automate" import { CodeWithAiNav } from "./code-with-ai" import { CollaborateNav } from "./collaborate" import { ContributingNav } from "./contributing" +import { CustomizeNav } from "./customize" import { DeploySecureNav } from "./deploy-secure" import { GettingStartedNav } from "./getting-started" import { ToolsNav } from "./tools" @@ -10,6 +11,7 @@ import { ToolsNav } from "./tools" export const Nav = { GettingStartedNav, CodeWithAiNav, + CustomizeNav, CollaborateNav, AutomateNav, DeploySecureNav, diff --git a/packages/kilo-docs/next-env.d.ts b/packages/kilo-docs/next-env.d.ts index 0d0841f57b6..3a85e45e9f5 100644 --- a/packages/kilo-docs/next-env.d.ts +++ b/packages/kilo-docs/next-env.d.ts @@ -1,6 +1,6 @@ /// /// -import "./.next/dev/types/routes.d.ts" +import "./.next/types/routes.d.ts" // NOTE: This file should not be edited // see https://nextjs.org/docs/pages/api-reference/config/typescript for more information. diff --git a/packages/kilo-docs/pages/code-with-ai/index.md b/packages/kilo-docs/pages/code-with-ai/index.md index a461777c627..1601be90e9f 100644 --- a/packages/kilo-docs/pages/code-with-ai/index.md +++ b/packages/kilo-docs/pages/code-with-ai/index.md @@ -24,9 +24,10 @@ Use Kilo Code wherever you work: - [**VS Code**](/docs/code-with-ai/platforms/vscode) — The most popular IDE integration - [**JetBrains**](/docs/code-with-ai/platforms/jetbrains) — IntelliJ, PyCharm, WebStorm, and more - [**CLI**](/docs/code-with-ai/platforms/cli) — Terminal-based AI coding for scripts and automation -- [**Web & Mobile**](/docs/code-with-ai/platforms/web-app) — Access Kilo from your browser +- [**Cloud Agent**](/docs/code-with-ai/platforms/cloud-agent) — Run Kilo in the cloud - [**Mobile Apps**](/docs/code-with-ai/platforms/mobile) — iOS and Android support - [**Slack**](/docs/code-with-ai/platforms/slack) — Chat with Kilo in your workspace +- [**App Builder**](/docs/code-with-ai/app-builder) — Create full-stack applications with AI ## Working with Agents @@ -37,6 +38,7 @@ Kilo uses specialized agents to help with different tasks: - [**Model Selection**](/docs/code-with-ai/agents/model-selection) — Choose the right AI model for each task - [**Context Mentions**](/docs/code-with-ai/agents/context-mentions) — Reference files, functions, and symbols - [**Orchestrator Mode**](/docs/code-with-ai/agents/orchestrator-mode) — Complex multi-step tasks +- [**Free & Budget Models**](/docs/code-with-ai/agents/free-and-budget-models) — Cost-effective AI options ## Features @@ -51,35 +53,9 @@ Core capabilities to boost your productivity: - [**Enhance Prompt**](/docs/code-with-ai/features/enhance-prompt) — Improve your prompts automatically - [**Git Commit Generation**](/docs/code-with-ai/features/git-commit-generation) — AI-powered commit messages -## Context & Memory - -Help Kilo understand your codebase: - -- [**Codebase Indexing**](/docs/code-with-ai/context/codebase-indexing) — Build an index of your code for better context -- [**Memory Bank**](/docs/code-with-ai/context/memory-bank) — Store project context and decisions -- [**Large Projects**](/docs/code-with-ai/context/large-projects) — Best practices for monorepos and large codebases - -## Customization - -Tailor Kilo to your workflow: - -- [**Custom Modes**](/docs/code-with-ai/customization/custom-modes) — Create specialized modes for your team -- [**Custom Instructions**](/docs/code-with-ai/customization/custom-instructions) — Add project-specific guidelines -- [**Custom Rules**](/docs/code-with-ai/customization/custom-rules) — Define when and how Kilo should act -- [**Prompt Engineering**](/docs/code-with-ai/customization/prompt-engineering) — Write effective prompts -- [**Skills**](/docs/code-with-ai/customization/skills) — Extend Kilo's capabilities -- [**Workflows**](/docs/code-with-ai/customization/workflows) — Automate repetitive tasks -- [**agents.md**](/docs/code-with-ai/customization/agents-md) — Configure agent behavior - -## App Building - -Build complete applications with Kilo: - -- [**App Builder**](/docs/code-with-ai/app-builder.md) — Create full-stack applications with AI -- [**Cloud Agent**](/docs/code-with-ai/platforms/cloud-agent) — Deploy agents to the cloud - ## Next Steps -- Explore the [**Automate**](/docs/automate) section for advanced workflows +- Explore [**Customize**](/docs/customize) to tailor Kilo to your workflow - Learn about [**Collaborating**](/docs/collaborate) with your team -- Set up [**Deploy & Secure**](/docs/deploy-secure) deployments +- Set up [**Automate**](/docs/automate) for CI/CD integration +- Configure [**Deploy & Secure**](/docs/deploy-secure) deployments diff --git a/packages/kilo-docs/pages/code-with-ai/customization/agents-md.md b/packages/kilo-docs/pages/customize/agents-md.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/customization/agents-md.md rename to packages/kilo-docs/pages/customize/agents-md.md diff --git a/packages/kilo-docs/pages/code-with-ai/context/codebase-indexing.md b/packages/kilo-docs/pages/customize/context/codebase-indexing.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/context/codebase-indexing.md rename to packages/kilo-docs/pages/customize/context/codebase-indexing.md diff --git a/packages/kilo-docs/pages/code-with-ai/context/large-projects.md b/packages/kilo-docs/pages/customize/context/large-projects.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/context/large-projects.md rename to packages/kilo-docs/pages/customize/context/large-projects.md diff --git a/packages/kilo-docs/pages/code-with-ai/context/memory-bank.md b/packages/kilo-docs/pages/customize/context/memory-bank.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/context/memory-bank.md rename to packages/kilo-docs/pages/customize/context/memory-bank.md diff --git a/packages/kilo-docs/pages/code-with-ai/customization/custom-instructions.md b/packages/kilo-docs/pages/customize/custom-instructions.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/customization/custom-instructions.md rename to packages/kilo-docs/pages/customize/custom-instructions.md diff --git a/packages/kilo-docs/pages/code-with-ai/customization/custom-modes.md b/packages/kilo-docs/pages/customize/custom-modes.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/customization/custom-modes.md rename to packages/kilo-docs/pages/customize/custom-modes.md diff --git a/packages/kilo-docs/pages/code-with-ai/customization/custom-rules.md b/packages/kilo-docs/pages/customize/custom-rules.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/customization/custom-rules.md rename to packages/kilo-docs/pages/customize/custom-rules.md diff --git a/packages/kilo-docs/pages/customize/index.md b/packages/kilo-docs/pages/customize/index.md new file mode 100644 index 00000000000..1f13faccc34 --- /dev/null +++ b/packages/kilo-docs/pages/customize/index.md @@ -0,0 +1,51 @@ +--- +title: "Customize" +description: "Make Kilo Code work your way with custom modes, rules, instructions, and more" +--- + +# {% $markdoc.frontmatter.title %} + +{% callout type="generic" %} +Kilo Code is highly customizable. Tailor its behavior to match your workflow, team standards, and project requirements with custom modes, rules, instructions, and more. +{% /callout %} + +## Customization + +Configure how Kilo Code behaves and responds: + +- [**Custom Modes**](/docs/customize/custom-modes) — Create specialized modes for different tasks (code review, documentation, testing, etc.) +- [**Custom Rules**](/docs/customize/custom-rules) — Define rules that apply to specific file types or situations +- [**Custom Instructions**](/docs/customize/custom-instructions) — Add project-specific guidelines and context +- [**agents.md**](/docs/customize/agents-md) — Configure agent behavior at the project level +- [**Workflows**](/docs/customize/workflows) — Automate multi-step processes +- [**Skills**](/docs/customize/skills) — Extend Kilo's capabilities with reusable skill definitions +- [**Prompt Engineering**](/docs/customize/prompt-engineering) — Write effective prompts for better results + +## Context & Indexing + +Help Kilo understand your codebase better: + +- [**Codebase Indexing**](/docs/customize/context/codebase-indexing) — Build a semantic index of your code for better context awareness +- [**Memory Bank**](/docs/customize/context/memory-bank) — Store project context, decisions, and important information +- [**Large Projects**](/docs/customize/context/large-projects) — Best practices for working with monorepos and large codebases + +## Getting Started + +New to customization? Here's where to start: + +1. **Start with Custom Instructions** — Add a simple `.kilocode/instructions.md` file to your project +2. **Explore Custom Modes** — Try the built-in modes first, then create your own +3. **Enable Codebase Indexing** — Help Kilo understand your project structure + +## Best Practices + +- Keep custom instructions concise and actionable +- Use custom modes for repetitive tasks +- Combine rules with modes for powerful workflows +- Regularly update your memory bank with important decisions + +## Next Steps + +- Check out [**Code with AI**](/docs/code-with-ai) to learn how to use Kilo effectively +- Explore [**Automate**](/docs/automate) for CI/CD integration and advanced automation +- Learn about [**Collaboration**](/docs/collaborate) features for teams diff --git a/packages/kilo-docs/pages/code-with-ai/customization/prompt-engineering.md b/packages/kilo-docs/pages/customize/prompt-engineering.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/customization/prompt-engineering.md rename to packages/kilo-docs/pages/customize/prompt-engineering.md diff --git a/packages/kilo-docs/pages/code-with-ai/customization/skills.md b/packages/kilo-docs/pages/customize/skills.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/customization/skills.md rename to packages/kilo-docs/pages/customize/skills.md diff --git a/packages/kilo-docs/pages/code-with-ai/customization/workflows.md b/packages/kilo-docs/pages/customize/workflows.md similarity index 100% rename from packages/kilo-docs/pages/code-with-ai/customization/workflows.md rename to packages/kilo-docs/pages/customize/workflows.md diff --git a/packages/kilo-docs/previous-docs-redirects.js b/packages/kilo-docs/previous-docs-redirects.js index 85cb0ad7edd..53652180735 100644 --- a/packages/kilo-docs/previous-docs-redirects.js +++ b/packages/kilo-docs/previous-docs-redirects.js @@ -184,69 +184,131 @@ module.exports = [ }, // ============================================ - // CODE WITH AI - Context & Indexing + // CUSTOMIZE - Context & Indexing // ============================================ { source: "/features/codebase-indexing", - destination: "/docs/code-with-ai/context/codebase-indexing", + destination: "/docs/customize/context/codebase-indexing", basePath: false, permanent: true, }, { source: "/advanced-usage/memory-bank", - destination: "/docs/code-with-ai/context/memory-bank", + destination: "/docs/customize/context/memory-bank", basePath: false, permanent: true, }, { source: "/advanced-usage/large-projects", - destination: "/docs/code-with-ai/context/large-projects", + destination: "/docs/customize/context/large-projects", + basePath: false, + permanent: true, + }, + // Old code-with-ai/context paths redirect to new customize/context paths + { + source: "/code-with-ai/context/codebase-indexing", + destination: "/docs/customize/context/codebase-indexing", + basePath: false, + permanent: true, + }, + { + source: "/code-with-ai/context/memory-bank", + destination: "/docs/customize/context/memory-bank", + basePath: false, + permanent: true, + }, + { + source: "/code-with-ai/context/large-projects", + destination: "/docs/customize/context/large-projects", basePath: false, permanent: true, }, // ============================================ - // CODE WITH AI - Customization + // CUSTOMIZE - Customization // ============================================ { source: "/agent-behavior/custom-modes", - destination: "/docs/code-with-ai/customization/custom-modes", + destination: "/docs/customize/custom-modes", basePath: false, permanent: true, }, { source: "/agent-behavior/custom-rules", - destination: "/docs/code-with-ai/customization/custom-rules", + destination: "/docs/customize/custom-rules", basePath: false, permanent: true, }, { source: "/agent-behavior/custom-instructions", - destination: "/docs/code-with-ai/customization/custom-instructions", + destination: "/docs/customize/custom-instructions", basePath: false, permanent: true, }, { source: "/agent-behavior/agents-md", - destination: "/docs/code-with-ai/customization/agents-md", + destination: "/docs/customize/agents-md", basePath: false, permanent: true, }, { source: "/agent-behavior/workflows", - destination: "/docs/code-with-ai/customization/workflows", + destination: "/docs/customize/workflows", basePath: false, permanent: true, }, { source: "/agent-behavior/skills", - destination: "/docs/code-with-ai/customization/skills", + destination: "/docs/customize/skills", basePath: false, permanent: true, }, { source: "/agent-behavior/prompt-engineering", - destination: "/docs/code-with-ai/customization/prompt-engineering", + destination: "/docs/customize/prompt-engineering", + basePath: false, + permanent: true, + }, + // Old code-with-ai/customization paths redirect to new customize paths + { + source: "/code-with-ai/customization/custom-modes", + destination: "/docs/customize/custom-modes", + basePath: false, + permanent: true, + }, + { + source: "/code-with-ai/customization/custom-rules", + destination: "/docs/customize/custom-rules", + basePath: false, + permanent: true, + }, + { + source: "/code-with-ai/customization/custom-instructions", + destination: "/docs/customize/custom-instructions", + basePath: false, + permanent: true, + }, + { + source: "/code-with-ai/customization/agents-md", + destination: "/docs/customize/agents-md", + basePath: false, + permanent: true, + }, + { + source: "/code-with-ai/customization/workflows", + destination: "/docs/customize/workflows", + basePath: false, + permanent: true, + }, + { + source: "/code-with-ai/customization/skills", + destination: "/docs/customize/skills", + basePath: false, + permanent: true, + }, + { + source: "/code-with-ai/customization/prompt-engineering", + destination: "/docs/customize/prompt-engineering", basePath: false, permanent: true, },