Skip to content

ADR check: support additional directory paths (specs/, docs/design/, etc.) #414

Description

@rhuss

Context

Running AgentReady on the Kagenti repos, we noticed the ADR check (architecture_decisions) only accepts four directory paths.

Limited directory paths

The check currently accepts: docs/adr/, .adr/, adr/, docs/decisions/. Some projects use specs/ or docs/specs/ for design documents that serve the same purpose. AgentReady itself has a specs/ directory. Projects following the MADR format sometimes use docs/architecture/ or docs/design/.

Proposal: Add specs/, docs/specs/, docs/architecture/, and docs/design/ to the accepted paths. Alternatively, make the directory path configurable via .agentready-config.yaml so projects can specify where their architectural decisions live.

Why this matters

Projects that maintain design documents outside the four hardcoded paths get a false failure on this check. The content exists, the check just doesn't look in the right place.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions