diff --git a/src/agentready/assessors/documentation.py b/src/agentready/assessors/documentation.py index ac294e92..c47fa8a5 100644 --- a/src/agentready/assessors/documentation.py +++ b/src/agentready/assessors/documentation.py @@ -479,7 +479,8 @@ def _create_remediation(self) -> Remediation: ], tools=[], commands=[], - examples=["""# Project Name + examples=[ + """# Project Name ## Overview What this project does and why it exists. @@ -502,7 +503,8 @@ def _create_remediation(self) -> Remediation: # Format code black . ``` -"""], +""" + ], citations=[ Citation( source="GitHub", @@ -555,6 +557,10 @@ def assess(self, repository: Repository) -> Finding: repository.path / ".adr", repository.path / "adr", repository.path / "docs" / "decisions", + repository.path / "specs", + repository.path / "docs" / "specs", + repository.path / "docs" / "architecture", + repository.path / "docs" / "design", ] adr_dir = None @@ -571,7 +577,7 @@ def assess(self, repository: Repository) -> Finding: measured_value="no ADR directory", threshold="ADR directory with decisions", evidence=[ - "No ADR directory found (checked docs/adr/, .adr/, adr/, docs/decisions/)" + "No ADR directory found (checked docs/adr/, .adr/, adr/, docs/decisions/, specs/, docs/specs/, docs/architecture/, docs/design/)" ], remediation=self._create_remediation(), error_message=None,