Post Change Checks

Post-Change Checks

After making substantive changes, run through these checks before finishing.

1. Documentation Updates

Identify which docs may be affected by the change:

Update only what changed - don't rewrite unrelated sections.

2. Consistency Checks

After updating docs, verify:

• Commands in docs actually work (correct paths, flags, service names)
• Port numbers match between docker-compose.yml, .env.example, docs
• Env var names match between .env.example, docker-compose.yml, docs
• Service names in docs match docker-compose.yml
• File paths referenced in docs exist
• No user-specific absolute paths — use ~ (tilde) per project convention
• uv run used everywhere instead of python (project convention)

3. Lint Check

Run ReadLints on all files you edited to catch introduced errors. Fix any you introduced.

When to Skip

• Pure refactors with no user-facing or config changes
• Changes only to test files
• Changes deep inside a single module with no doc surface

Converted and distributed by TomeVault — claim your Tome and manage your conversions.