devkit-pi Documentation

docs/ contains the public VitePress documentation site for devkit-pi's subagents, Web research tools, content conversion, LSP code intelligence, developer commands, and lightweight workflow reminders. It is intentionally limited to user-facing guides and API/reference material.

Internal maintainer material such as architecture notes, testing strategy, release checklists, ADRs, planning, issue logs, archive notes, and audits lives outside the website in internal-docs/.

Current behavior should be determined by src/, tests/, and the current reference docs in docs/reference/.

Documentation site

Online documentation site: https://devkit-pi.wangyan.life/

npm package: https://www.npmjs.com/package/devkit-pi

Local preview commands:

pnpm docs:dev
pnpm docs:build
pnpm docs:preview

Public sections

Guides

• Goals and scope: project goals, included/excluded capabilities, and design boundaries.
• Agent workflow guide: lightweight workflow methods for planning, implementation, debug, review, and verification reporting.
• Security model: security boundaries for subagents, Web tools, convert, LSP, guards, and write capability.

Reference

• Reference index
• Configuration reference
• Subagents reference
• Subagent tool reference
• Agent definition reference
• Result schema reference
• Web tools reference
• Web providers reference
• Web tools error codes
• LSP tools reference
• Convert tools reference
• Toolkit commands reference

Recommended reading path

New users

1. Goals and scope
2. Agent workflow guide
3. Security model
4. Configuration reference
5. Toolkit commands reference

Using Subagents

Readonly subagents are recommended by default. Writable custom subagents are experimental — subagents.allowWrite=true does not imply sandbox, audit, or rollback guarantees.

1. Subagents reference
2. Subagent tool reference
3. Agent definition reference
4. Result schema reference

Using Web / LSP / Convert tools

• Web tools reference
• LSP tools reference
• Convert tools reference

Content policy

• docs/ is the public website surface.
• internal-docs/ is the internal maintainer knowledge base.
• Planning, archive, ADR, issue, audit, and release-process documents are not part of the public website navigation.
• Proposed/roadmap/archive material does not represent current behavior unless it is also reflected in source, tests, and current reference docs.