Skip to main content

Serpent Documentation

Documentation is organized into two parts: Public documentation (distributed with the product) and Internal development records (for development process, not distributed).

Public Documentation​

DocumentDescription
User GuideInstall, import, browse, search and filter, tags/collections, viewer, AI analysis, plugins/MCP, troubleshooting (Bilingual)
Developer DocsLocal development, architecture, testing, build & packaging (Bilingual; shipped on main)
Contributing GuideCommunity collaboration guidelines, Pull Request standards, and code submission workflows
Extension Author ManualPlugin, script, and MCP development guides and API references
Product BriefProduct vision and MVP boundaries
GlossaryDomain terminology

Internal Development Records (Not Distributed)​

Development process documents live in docs/internal/ on the repository's dev branch (not published to the site): architectural decisions (ADR), implementation specifications, development logs, QA reports, code reviews, technical research, development workflows, and project status.

AI agent instructions are in AGENTS.md and CLAUDE.md.