Skip to content

rename AGENTS.md to usage-rules.md for usage_rules ecosystem compatibility #31

@matt-beanland

Description

@matt-beanland

The usage_rules hex package (ash-project/usage_rules) is becoming the standard way for Elixir libraries to ship AI agent guidance that consumers can sync into their CLAUDE.md / AGENTS.md via mix usage_rules.sync.

The sync task discovers rules by looking for deps/*/usage-rules.md — it does not pick up AGENTS.md.

bolty's AGENTS.md already contains exactly the right content for consumer-facing usage rules (sections 1–11 and 15 cover everything a library consumer needs). Renaming it to usage-rules.md would make bolty a first-class citizen in the usage_rules ecosystem with no content changes required.

Consumers (e.g. artefactory_neo4j) could then add :bolty to their usage_rules: config in mix.exs and have bolty's guidance automatically included when they run mix usage_rules.sync.

Suggested change: rename AGENTS.mdusage-rules.md (or add usage-rules.md that includes/mirrors the content if the AGENTS.md name is load-bearing for other tooling).

Metadata

Metadata

Assignees

No one assigned

    Labels

    choremaintenance or housekeeping

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions