Skip to content

AGENTS.md project tree calls clients/ "one subdir per service" but layout is flat #20

@ooloth

Description

@ooloth

Why

A cold reader (human or agent) following AGENTS.md will create clients/src/<service>/mod.rs when adding a new client, contradicting the existing flat convention.

Current state

Line 31 reads clients/ # external API wrappers — one subdir per service. The actual layout in clients/src/ is flat files: github.rs, linear.rs, lib.rs, plus the private/ symlink. clients/README.md itself uses the permissive wording "one file or subdirectory per external service".

Ideal state

  • AGENTS.md line 31 matches the permissive wording, e.g. one file (or subdirectory) per external service
  • AGENTS.md and clients/README.md are consistent with each other

Starting points

  • AGENTS.md line 31
  • clients/README.md line 7

QA plan

  1. Read AGENTS.md line 31 and clients/README.md line 7 — expect both to use equivalent wording
  2. Check clients/src/ listing — expect the wording to accurately describe the flat layout

Done when

AGENTS.md no longer prescribes a subdir-only layout for clients/.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions