This repository was archived by the owner on Aug 27, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 55
Expand file tree
/
Copy path.kilocoderules
More file actions
31 lines (25 loc) · 1.49 KB
/
.kilocoderules
File metadata and controls
31 lines (25 loc) · 1.49 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Kilo Code Documentation Rules
## Documentation Links
- Do not include .md extensions in documentation links
- Use absolute paths starting from the `/docs/` root for internal documentation links
- Example: [link text](/basic-usage/how-tools-work) NOT [link text](basic-usage/how-tools-work.md) or [link text](../../basic-usage/how-tools-work)
This ensures links work correctly in the built documentation while maintaining clean URLs.
## Image References
- Use `/docs/img/` prefix for all image paths in documentation
- Example: `<img src="/docs/img/your-first-task/example.png" alt="Description" width="600" />`
- NOT: `<img src="img/example.png" ...>` or `<img src="../static/img/example.png" ...>`
## Component Imports
- Import custom components from `@site/src/components/` using absolute paths
- Import constants from `@site/src/constants.ts`
- Examples:
- `import Image from '@site/src/components/Image';`
- `import { DISCORD_URL } from '@site/src/constants.ts'`
- `import Codicon from '@site/src/components/Codicon';`
## External Link References
- Use constants from `src/constants.ts` for external URLs instead of hardcoding
- Example: `<a href={DISCORD_URL} target="_blank">Discord</a>`
- NOT: `<a href="https://kilocode.ai/discord">Discord</a>`
## Sidebar Configuration
- Document IDs in `sidebars.ts` should match file paths without extensions
- Use `type: 'doc'` with custom labels when the sidebar label differs from the document title
- Group related documents under categories with descriptive labels