Kevin van Dijk
19a52a262f
git-subtree-dir: apps/kilocode-docs git-subtree-mainline: 0ab87945123cba85a6e76ca5a7f427197b7e1f77 git-subtree-split: 79ed21f1913d5d8426c39e7ecf19907a1a2913e1
32 lines
1.5 KiB
Plaintext
32 lines
1.5 KiB
Plaintext
# 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
|