docs: clarify example agents.yaml path

[aniketkrs]

The README says tenant package agents are declared in agents.yaml, but there is no such file at the repo root (it 404s). The file that actually ships with the example package is examples/fintech/agents.yaml, which is also what .env.example points at via TENANT_PACKAGE_DIR.

This change names the real path so a reader can find the file on the first try. Tightly scoped to that one line.

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[davidmckayv]

Thanks for this, and the observation is right: there is no agents.yaml at the repo root. The only one in the tree is examples/fintech/agents.yaml, and .env.example points TENANT_PACKAGE_DIR at ../examples/fintech.

The edit as written trades one wrong path for another, though. That sentence describes how any tenant package works, and the README says a few lines above it that you replace the example package under examples/ with your own coworkers. Naming examples/fintech/agents.yaml there tells somebody who has done exactly that their agents are declared in the package they just deleted.

One claim worth dropping from the description: the README never links agents.yaml, it is a code span, so nothing 404s. The real problem is that a bare filename does not say which directory it sits in.

There is also a bigger staleness in that same line, which is the more useful thing to fix. #608 shipped a coworker in a file of its own, and line 46 already mentions examples/fintech/agents/, but line 212 still says agents are declared in agents.yaml and stops there.

If you want to take another pass, something like:

Tenant package agents are declared in the package's own agents.yaml, in the directory TENANT_PACKAGE_DIR names (examples/fintech by default), or each in a file of its own under that package's agents/ directory, as either:

That keeps the two bullets underneath working, says where the file actually is without pinning a forked deployment to the example, and picks up the one-file-per-coworker path at the same time. Happy to merge that.

Or say the word and I will push the edit to this branch so it stays yours.