Skip to content

docs: state companion repo visibility truthfully in AGENTS.md - #333

Open
alanjds wants to merge 1 commit into
developfrom
docs-companion-repo-visibility
Open

alanjds wants to merge 1 commit into
developfrom
docs-companion-repo-visibility

Conversation

@alanjds

@alanjds alanjds commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

TL;DR

  • AGENTS.md headed its companion list "(public)" although the server repo on it is private, so the "don't name private repos" rule read as not applying to it. The heading is now plain and each bullet states its own visibility.
  • The naming rule now covers the server repo, which is upstream of this SDK (the old wording only covered downstream services): PR and commit text says "the server".
  • Docs only: one file (CLAUDE.md is a symlink to it).

The "Companion repos (public)" heading also covered the private server
repo, which reads as permission to name it in PR and commit text. Mark
each companion's visibility per bullet, and extend the naming rule to the
server repo (upstream of this SDK): call it "the server".

Co-Authored-By: Alan Justino <alan.justino@yahoo.com.br>
@claude

claude Bot commented Oct 20, 2026

Copy link
Copy Markdown

Clean against AGENTS.md and specs/: docs-only change, targets develop, no version bump, and it doesn't conflict with specs/05-downstream-contract.md §Companion repos, which doesn't call the server repo public.

@alanjds
alanjds requested a review from a team October 21, 2026 17:50
@alanjds

alanjds commented Oct 21, 2026

Copy link
Copy Markdown
Contributor Author

@dmou-ps and @sbneto: The current AGENTS.md had named some of our internal repos. Now it names it to say that it should not be named.

Should this PR be merged, or should we adopt some other approach to its intent?

@dmou-ps dmou-ps left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

keeping it as private is good, but the fact that ai is referenced in the publicly viewable md file anyway makes it a bit moot. we should consider open source agent.md standards across our public repos, but probably a discussion better had outside of this repo :)

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

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants