docs
Documentation conventions for Ghost's user-facing docs site (Astro Starlight). MUST READ before creating or updating any page under docs/, modifying CLI help text, or changing user-facing behavior that needs documentation. Covers which doc file to update for each change type, build verification, formatting, and terminology rules.
- License 许可
- MIT
- 所属仓库
- mrtolkien/GHOST
- 最近更新
- 2026-04-24
- Stars
- ★ 5
- Forks
- 0
01 前言 Front Matter
- name
- docs
- description
- Documentation conventions for Ghost's user-facing docs site (Astro Starlight). MUST READ before creating or updating any page under docs/, modifying CLI help text, or changing user-facing behavior that needs documentation. Covers which doc file to update for each change type, build verification, formatting, and terminology rules.
03 SKILL.md 正文
Documentation Conventions
User-facing docs live in docs/ (Astro Starlight).
Which File to Update
| Change type | Doc file |
|---|---|
| CLI changes | docs/src/content/docs/reference/cli.md |
| Config changes | docs/src/content/docs/getting-started/configuration.md |
| Core tools | docs/src/content/docs/skills-and-tools/core-tools.md |
| Knowledge tools | docs/src/content/docs/knowledge/tools.md |
| Web research tools | docs/src/content/docs/web-research/tools.md |
| Workspace/bootstrap | docs/src/content/docs/getting-started/workspace.mdx |
| Provider changes | docs/src/content/docs/ghost/providers.md |
| Agent changes | docs/src/content/docs/agents/ (introduction.md, syntax.md, context.md, cron.md, agent-control.md) |
| Chat/session changes | docs/src/content/docs/chat/ (sessions.md, compaction.md) |
| Knowledge features | docs/src/content/docs/knowledge/ (knowledge.mdx, reflection.md, tools.md) |
| Skills & tools overview | docs/src/content/docs/skills-and-tools/ (overview.md, creating-skills.md, default-skills.md, core-tools.md) |
| Web research features | docs/src/content/docs/web-research/ (overview.md, tools.md) |
| Identity/interfaces | docs/src/content/docs/ghost/ (identity.md, interfaces.mdx, providers.md) |
| Dependencies | docs/src/content/docs/reference/dependencies.md |
Build Verification
Always verify docs build after changes:
cd docs && npm run build
Formatting
- Docs content (
docs/src/content/**) is excluded from oxfmt because Starlight's:::admonition syntax is not supported by Prettier-compatible formatters. - Line width: 88 characters for all other markdown/MDX/JSON/TOML (via oxfmt).
Terminology
Always write GHOST and OPERATOR in all caps in prose. Keep real code/file
identifiers (crate names, paths, variable names) unchanged.
04 同仓库更多 Skills
system-management
Use when reading or changing GHOST configuration (providers, models, timing, compaction, services, any config.toml key), adding or switching LLM providers, answering questions about GHOST's own features or capabilities, a CLI tool is missing or "not found", services need starting/stopping/debugging, updating GHOST to a newer version, managing the Nix shell environment, or troubleshooting GHOST setup.
writing-skills
Use when creating new skills, editing existing skills, or verifying skills work before deployment
writing-plans
Use when you have a spec or requirements for a multi-step task, before touching code. Write comprehensive implementation plans assuming the engineer has zero context for our codebase and questionable taste.
verification
Use when about to claim work is complete, fixed, or passing, before committing or creating PRs. Requires running verification commands and confirming output before making any success claims. Evidence before assertions, always.
tdd
Use when implementing any feature or bugfix, before writing implementation code. Write the test first. Watch it fail. Write minimal code to pass.
systematic-debugging
Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes