docs: add harness engineering guides and reorganize docs structure#589
Conversation
Separate user-facing guides from developer-facing docs: - Create docs/contributing/ for internal developer docs - Move adding-a-language.md from guides/ to contributing/ - Add docs/contributing/harness-engineering.md (internal practices) - Add docs/use-cases/harness-engineering.md (user-facing use case) - Update references in README, SUPPORT, CONTRIBUTING
|
Claude finished @carlos-alm's task —— View job PR Review: Harness Engineering DocumentationI've conducted a comprehensive review following the 5-phase process: Todo List
Root Cause AnalysisProblem Being Solved: Adding comprehensive harness engineering documentation to codegraph. The PR addresses the gap where users need guidance on how to systematically prevent AI agent mistakes using codegraph as enforcement infrastructure. Why This Approach: Creates both user-facing (use-cases/) and developer-facing (contributing/) documentation, following established patterns in the codebase. The reorganization separates concerns properly - user guides vs contributor docs. Risk Assessment: Zero risk - this is documentation-only with no code changes. Phase 2: Configuration Changes ✅No high-risk configuration changes detected. Only documentation files were modified:
Phase 3: Test Integrity ✅No test files modified. No test expectations changed. No red flags detected. Phase 4: Code Quality AssessmentStrengths:
Technical accuracy:
Areas for improvement (minor):
Backlog Compliance
Critical ConcernsNone. This is high-quality documentation that fills an important gap. Final AssessmentRecommendation: APPROVE - This is exemplary documentation that provides immediate value to users wanting to implement harness engineering patterns with codegraph. |
Greptile SummaryThis PR reorganizes the docs directory by separating user-facing ( Notable items:
Confidence Score: 5/5
Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
subgraph Before
A1[docs/guides/adding-a-language.md]
end
subgraph After["After (this PR)"]
B1[docs/contributing/adding-a-language.md]
B2[docs/contributing/harness-engineering.md\nNEW — internal dev reference]
B3[docs/use-cases/harness-engineering.md\nNEW — user-facing guide]
B4[docs/guides/recommended-practices.md\nunchanged]
end
subgraph References
R1[README.md]
R2[CONTRIBUTING.md]
R3[SUPPORT.md]
end
A1 -- renamed --> B1
R1 -- link updated --> B1
R2 -- link updated --> B1
R3 -- link updated --> B1
B3 -- cross-references --> B4
B3 -- cross-references --> B2
B3 --> C1[docs/roadmap/ROADMAP.md]
B3 --> C2[docs/roadmap/BACKLOG.md]
B3 --> C3[docs/examples/claude-code-hooks/README.md]
B2 --> C3
Reviews (1): Last reviewed commit: "docs: add harness engineering guides and..." | Re-trigger Greptile |
|
Addressed Claude's review feedback:
Commit: afafbb4 |
Summary
docs/guides/) from developer-facing docs (docs/contributing/). Moveadding-a-language.mdtodocs/contributing/and update all references.docs/use-cases/harness-engineering.md): User-facing guide explaining how codegraph powers harness engineering — the discipline of building systems that prevent AI agents from repeating mistakes. Follows the titan-paradigm.md style with problem statement, codegraph command mappings, roadmap features, and new backlog items.docs/contributing/harness-engineering.md): Developer-facing guide with the 9 core practices (AGENTS.md as ToC, remediation-focused linters, silent success/loud failure, mechanical architecture, sub-agents, progress files, e2e verification, wrapper CLIs, continuous GC).Test plan
docs/contributing/adding-a-language.mdpath