Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/agentready/assessors/documentation.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -502,7 +503,8 @@ def _create_remediation(self) -> Remediation:
# Format code
black .
```
"""],
"""
],
citations=[
Citation(
source="GitHub",
Expand Down Expand Up @@ -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
Expand All @@ -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,
Expand Down
Loading