Skip to content

docs: the starter guidelines live in .agents/guidelines - #11

Merged
AlexeyShalaev merged 1 commit into
masterfrom
docs/guidelines-out-of-docs
Oct 7, 2026
Merged

AlexeyShalaev merged 1 commit into
masterfrom
docs/guidelines-out-of-docs

Conversation

@AlexeyShalaev

Copy link
Copy Markdown
Member

The hub template moves the guidelines of its python-service and python-library packs from docs/guidelines/ to .agents/guidelines/: many projects publish docs/ as their documentation site, and the guidelines are for the people and agents who change the code. This follows it here:

  • the opt-in examples (concepts/packs, getting-started/opt-in, reference/opt-in, the testdata example) ignore .agents/guidelines/**, and TestOptInHash pins the new hash of the documented example (printf 'touchmark-optin/v1\nversion 1\npack 6:claude\nignore 21:.agents/guidelines/**\nignore 21:.claude/settings.json\n' | sha256sum);
  • guide/local's --adopt example uses the new path;
  • the GitLab template test looks for .agents/guidelines/database.md on the sync branch;
  • the GitHub guide's diagram says a repository is opted in or subscribed by the hub.

Merge after the template's change, so that the GitLab template test and the template agree.

The hub template now ships the guidelines of python-service and python-library to .agents/guidelines/ rather than docs/, which many projects publish as their documentation site. The opt-in examples ignore that path, the documented example's hash in TestOptInHash follows, and the GitLab template test looks for database.md there. The GitHub guide's diagram also says a hub can subscribe a repository.
@AlexeyShalaev
AlexeyShalaev merged commit 8f0d312 into master Oct 7, 2026
22 checks passed
@AlexeyShalaev
AlexeyShalaev deleted the docs/guidelines-out-of-docs branch October 7, 2026 11:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant