القائمة
Verify all project documentation reflects current codebase state after feature changes
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Scaffold eval test cases for an agent in backend/evals/test_cases.py, following the TestCase dataclass pattern used by DATA_AGENT_CASES, KNOWLEDGE_AGENT_CASES, and WEB_SEARCH_CASES
Scaffold a new Agno agent with boilerplate, register in main.py, and add config.yaml entry
Scaffold a new Agno multi-agent team with boilerplate, register in main.py, and create docs page
Scaffold a new Agno workflow with Steps, Loops, and Conditions, register in main.py, and create docs page
Scaffold a new mise task with correct headers, flags, and conventions
Pre-release validation checklist — verify versions, CI, docs, and Docker before running mise run release
| name | doc-sync |
| description | Verify all project documentation reflects current codebase state after feature changes |
| disable-model-invocation | true |
Systematically verify all documentation files reflect the current codebase after feature changes.
After any feature PR, enhancement batch, or structural change to agents, teams, workflows, tools, context modules, or evals.
Run git diff --stat (or git diff --stat HEAD~N for recent commits) to get the list of changed backend/frontend files. Categorize changes:
Verify each file against the changes identified in Step 1. Read the actual file content, do not rely on memory.
| File | What to Check |
|---|---|
CLAUDE.md | Backend packages list, commands section (task descriptions), conventions section (env vars, patterns), Agno API notes |
README.md | Agents table, Development Tasks table (task flags), env vars table, CLI section |
PROJECT_INDEX.md | Project structure tree, core modules section, env vars table, architecture notes |
.serena/memories/project-overview.md | Agents list, tools list, context list, evals description, mise tasks list, env vars |
docs/agents/*.mdx | Per-agent pages: code example, features table, tools list, example queries |
docs/reference/architecture.mdx | Backend directory table, project structure tree, evals description |
docs/reference/code-map.mdx | Agent wiring diagram, agent wiring table, context module table, eval harness diagram/table, tool patterns |
docs/configuration/environment.mdx | All env var sections, new variable categories |
frontend/README.md | Only if frontend changes were made |
backend/README.md | Only if backend changes were made |
Present findings as a checklist:
Documentation Sync Results:
PASS:
- [x] CLAUDE.md — all changes reflected
- [x] PROJECT_INDEX.md — all changes reflected
GAPS FOUND:
- [ ] README.md — missing `-s` flag in evals:run task (line N)
- [ ] docs/agents/knowledge-agent.mdx — code example outdated (missing FileTools)
For each gap found, make the edit. After all edits:
mise run docs:validate to verify Mintlify build + broken linksmise run validate to verify backend + frontend code qualityOnly claim completion after both validations pass with fresh output evidence.