Skip to content

Procedures

Find instructions for a development or operations task. These guides serve both developers and coding agents; each link opens the maintained procedure in its existing documentation.

Start with the task below, then check the guide's prerequisites, working directory, and environment before running commands. Follow its verification steps to confirm the result. Agents must also read the applicable repository instructions; a guide does not expand the user's authorization.

Setup

Task Procedure
Prepare a workspace and download dependencies/environment files Development setup
Start backend services Backend setup
Start a frontend Frontend development servers
Create an isolated database Supabase preview setup
Prepare local or preview test data Supabase seeding
Load dedicated chatbot CLI credentials Per-CLI secrets

Testing

Task Procedure
Run Python unit/integration tests and configure credentials Backend testing
Verify knowledge ingestion, tenant isolation and retrieved passages Knowledge change verification
Run frontend tests, type checks, and handle worker cleanup Frontend testing
Evaluate chatbot responses Evaluation examples
Compare model accuracy and latency Model benchmarking

Database changes

Task Procedure
Choose a database and apply a schema change Supabase workflows
Inspect an existing function, view, or table Inspect existing objects
Write migrations that also work on a fresh database Migration authoring and replay
Regenerate frontend database types Generated types after migrations
Recover missing local migration history Externally applied history
Run a heavy refresh or index build Operator procedures

Debugging

Task Procedure
Find dev-server logs or replay an authenticated API request Local logs and authentication
Choose a chat test environment and check client knowledge freshness Chat environment preflight
Reproduce a chatbot conversation Chat CLI examples
Diagnose retrieval initialization failures Retrieval troubleshooting
Diagnose frontend startup or rendering problems Frontend troubleshooting
Diagnose database login, permissions, or missing seed data Supabase debugging
Inspect production logging and adjust verbosity Logging and production debugging

Releases

Task Procedure
Prepare a PR or merge a feature Development workflow
Run merge/release checks and follow deployment Merge workflow
Build and release backend services Backend release management
Deploy a frontend Frontend deployment

Documentation maintenance

Task Procedure
Preview and build the documentation site Local documentation development
Create or simplify agent instructions and their linked procedures Maintaining AGENTS.md and shared procedures

When adding a procedure, update its existing guide and add a task link here. Write for both people and agents: prerequisites → steps → expected result → verification. Link directly to it from the nearest applicable AGENTS.md. Keep architecture explanations and reference inventories in their existing topic pages.