AgentSkillsCN

update-docs

通过分析代码库，同步文档与当前实现，更新ryOS的文档资料。在更新文档、同步文档内容，或当文档内容已过时，这一原则能够为设计师提供有力的帮助。

SKILL.md
--- frontmatter
name: update-docs
description: Update ryOS documentation by analyzing the codebase and syncing docs with current implementation. Use when updating docs, syncing documentation, or when docs are outdated.

Update Documentation

Update manually-written docs by launching parallel sub-agents for each section.

Documentation Sections

SectionFilesRelated Code
Overview1-overview.md, 1.1-architecture.mdsrc/, api/, package.json
Apps Index2-apps.mdsrc/apps/*/index.ts, appRegistry.tsx
Framework3-*.md filessrc/components/layout/, src/stores/, src/themes/
AI System4-ai-system.mdapi/chat.ts, src/apps/chats/tools/
File System5-file-system.mduseFileSystemStore.ts, src/apps/finder/
Audio System6-audio-system.mdaudioContext.ts, useSound.ts, src/apps/synth/
UI Components7-*.md filessrc/components/ui/, src/lib/locales/
API Reference8-*.md filesapi/*.ts

Workflow

1. Launch Parallel Sub-Agents

For each section, launch a Task with:

  1. •Read current doc file(s)
  2. •Analyze relevant code for changes
  3. •Update outdated/missing info
  4. •Preserve existing structure
  5. •Report changes

2. Generate Changelog

For incremental updates (recommended):

bash
bun run scripts/generate-changelog.ts --months=1

For full regeneration (12 months):

bash
bun run scripts/generate-changelog.ts

3. Generate HTML

bash
bun run scripts/generate-docs.ts

4. Review Changes

bash
git diff docs/

Sub-Agent Prompts

Overview: Review package.json, src/ structure → update tech stack, features

Apps Index: Review src/apps/*/index.ts, appRegistry.tsx → update app list

Framework: Review WindowFrame.tsx, stores, themes → update window/state/theme docs

AI System: Review api/chat.ts, tools → update models, capabilities

File System: Review useFileSystemStore.ts, finder → update operations

Audio System: Review audioContext.ts, synth → update audio features

UI Components: Review src/components/ui/, locales → update component list, i18n

API Reference: Review api/*.ts → update endpoints, request/response formats

Section Shortcuts

ArgSections
overview1-overview, 1.1-architecture
apps2-apps
framework3-* files
ai4-ai-system
filesystem5-file-system
audio6-audio-system
ui7-* files
api8-* files

Notes

  • •Changelog: Use --months=1 for recent updates, full regen only when needed
  • •App docs: Individual app pages (2.1-2.18) are auto-generated via generate-app-docs.ts
  • •Preserve structure: Keep headings, mermaid diagrams, formatting
  • •Be conservative: Only update clearly outdated info
  • •Run HTML generation: Always run generate-docs.ts after updates