docs

AionUi Docs

Documentation is organized by reader intent, not by document type.

Directory	For whom	What lives here
`guides/`	Users & operators	How to deploy, test, and run the product. Server deployment, WebUI, Hub testing, CDP debugging.
`contributing/`	Contributors	Dev environment setup, file-structure conventions, PR automation workflow.
`architecture/`	Engineers & architects	System architecture overview, subsystem deep-dives (ACP, queue, team mode), and supporting research notes.
`specs/`	Engineering-driven specs	Feature design docs, requirements, implementation plans (ACP rewrite, extension market, remote agent, wake prompt, PR notes).
`prds/`	Product team	Formal Product Requirement Documents maintained by the product team. Do not reorganize without their consent.
`readme/`	Global users	Translated copies of the root `readme.md` (Chinese, Japanese, Korean, Spanish, etc.).

New to the project? Start with architecture/overview.md.
Setting up a dev environment? See contributing/development.md.
Writing code? The entry point for code-style, linting, formatting, and commit rules is AGENTS.md at the repo root.
Deploying a server? guides/deploy-server.md.

Content type	Destination
User/ops-facing how-to	`guides/`
Contributor convention, workflow, or tooling rule	`contributing/`
System or subsystem design, technical analysis	`architecture/`
Exploratory research, analysis reports	`architecture/research/`
Feature requirements / design drafts driven by engineering	`specs/<feature-name>/`
Formal PRD owned by product team	`prds/` (coordinate first)
README translation	`readme/readme_<locale>.md`