Toju/docs-site/CONTEXT.md

Application Documentation (docs-site)

Owns the Docusaurus-based application and plugin-author documentation. The build output (docs-site/build/) is bundled into the Electron app and served by the Local API server at runtime, so documentation is available offline inside the desktop client.

Format reference:

• Vocabulary — bold term, one-sentence definition, aliases to avoid.
• Relationships — bullets with bold terms and cardinality.
• Boundaries / IO — what this subdomain exposes and consumes.
• Invariants — rules that always hold.
• Flagged ambiguities — terms in dispute with proposed resolutions.

See agents-docs/AGENTS_CONTEXT.md for the contract. Update in the same turn a trigger fires (see agents-docs/AGENT_WORKFLOW.md § CONTEXT.md upkeep).

Vocabulary

Term	Definition	Aliases to avoid
App docs	End-user-facing documentation for the Toju desktop client.	"manual"
Plugin docs	Developer-facing reference for the plugin runtime — manifest format, lifecycle hooks, host APIs. Authoritative source for the plugin contract surface.	"API docs"
Local API server	The Electron in-process HTTP server that mounts docs-site/build/ so the renderer can browse docs offline. Defined under electron/api/.	"embedded server"

Relationships

• Plugin docs describe contracts implemented in toju-app/src/app/shared-kernel/plugin-system.contracts.ts (renderer side) and electron/plugin-library.ts (host side) — keep them in lockstep with code changes.
• The build output at docs-site/build/ is a deploy artifact for the electron Local API server; npm run build:all requires npm run build:docs to have run.
• The site is also deployed publicly via .gitea/workflows/deploy-web-apps.yml for browsing outside the app.

Boundaries / IO

• Exposes: static Docusaurus bundle at docs-site/build/, mounted by Electron's Local API server and also deployed as a public static site.
• Consumes: Markdown sources under docs-site/docs/, plus any code-derived references (e.g. OpenAPI documents from electron/api/openapi.ts).

Invariants

• Plugin-contract documentation must match the code; if the manifest schema or lifecycle changes, plugin docs and agents-docs/features/<plugin-doc>.md both update in the same task.
• Build artifacts (docs-site/build/) are generated, not committed.

Flagged ambiguities

• None recorded yet.

---

Agent-procedural rules (TDD, lint, build) live in /AGENTS.md. This file is the bounded-context domain artefact for the documentation site.