-
Notifications
You must be signed in to change notification settings - Fork 0
Template Agent Guide
This is the canonical entry point for Codex, Claude Code, and other agents working on Praxis templates or generated repositories. A Wiki cannot force an agent to read every page, so Praxis provides a deterministic context-loading contract.
-
Read the agent instructions. In a repository session, load
AGENTS.md; Claude Code also loadsCLAUDE.mdand its shared import. - Read the Template Agent Guide. Finish this page before inspecting individual template directories.
-
Resolve the context bundle. Run the resolver against
praxis.config.jsonor explicit bundle IDs. - Read every required architecture page. Follow the returned order; prerequisites appear before dependants.
- Inspect authoritative sources. Read the returned configuration, manifests, overlays, runtime entry points, and contract tests.
- State the loaded context. Before editing, name the bundle IDs and the behavior boundary being changed.
- Run every required verification command. Fresh command output is required before completion claims.
From the Praxis repository:
node scripts/resolve-template-context.mjs --config /path/to/generated/praxis.config.jsonFor machine consumption:
node scripts/resolve-template-context.mjs --config /path/to/generated/praxis.config.json --jsonThe JSON/text modes return identical ordered bundle membership plus local pages, public Wiki URLs, sources, tests, and verification commands. Unknown bundles and incomplete Terraform selections fail instead of returning partial context.
node scripts/resolve-template-context.mjs \
--bundle pro-django \
--bundle capability-background-jobs \
--bundle pro-composeDependency expansion adds Redis context before background jobs. Use node scripts/resolve-template-context.mjs --bundle pro-terraform-aws for the shared Kubernetes/Terraform prerequisites plus AWS.
For each returned module:
- read its
manifest.jsonselectors and output scopes; - read the selected overlay directories, not every variant;
- follow persistent patch anchors into the base stack;
- trace request, startup, readiness, and shutdown paths;
- check how Compose/Kubernetes/Terraform consume the same capability selection;
- read the listed tests to learn the executable contract.
Do not call all stacks object-oriented. Express uses functional module composition; Django/DRF uses framework-driven OOP patterns; Go/Gin uses structs, interfaces, constructors, and explicit compile-time wiring.
Before a template change, record a short declaration such as:
Loaded
template-foundations,pro-django,capability-redis-cache,capability-background-jobs, andpro-compose; inspected their manifests/overlays and the Pro capability/runtime tests. Scope: Django worker startup and Compose dependency wiring.
This makes missing prerequisites visible during review.
npm run docs:context:check
npm run docs:test
npm run docs:checkThe context validator ensures selectable template families, Pro capabilities, Terraform clouds, dependencies, pages, source roots, and tests remain represented. The map is routing metadata; source and executable tests remain authoritative.
Start at this Wiki page, use links returned by the context map, and inspect matching paths on main. When a repository checkout is available, prefer local docs/ so documentation and source share one commit.
This Wiki is generated from the repository's versioned docs/ source. Update and review the source files; do not rely on hand edits to generated Wiki pages.
- Core-Internals
- Architecture
- Repository-Map
- Code-Architecture
- Generation-Pipeline
- Manifest-System
- UI-Templates
- Testing
- Agent-Guide
- Wiki-Publishing
- Template-Architecture
- Standard-Projects
- Standard-Frontend-Architecture
- Express-Architecture
- Fullstack-Architecture
- Praxis-Pro
- Django-Architecture
- Gin-Architecture
- Capability-Architecture
- Compose-Architecture
- Kubernetes-Architecture
- Terraform-Architecture
- Extending-Generated-Projects
- Generated-Backends