Skip to content

docs: add AGENTS.md and llms.txt, retire blueprint.yaml - #19

Merged
pablo19sc merged 1 commit into
aws-samples:mainfrom
pablo19sc:f-agents-md-llms-contract
Oct 19, 2026
Merged

pablo19sc merged 1 commit into
aws-samples:mainfrom
pablo19sc:f-agents-md-llms-contract

Conversation

@pablo19sc

Copy link
Copy Markdown
Contributor

Description

Prepares the repository for the Amazon VPC Lattice skill moving to its own home, where SKILLS.md and the skills/ package will be retired. Separates what is about this repository from what is about VPC Lattice, as was done in aws-samples/aws-cloud-wan-blueprints#30:

  • AGENTS.md (new) — a guide for an AI agent working in a local clone: where things are, the rules a change most often breaks, which checks to run for what changed, how to contribute, and how to deploy a pattern safely. It links to CONVENTIONS.md rather than restating it.
  • llms.txt (new) — the stable entry point for agents reading the repository remotely: every category, pattern and auth-toolkit page with the question it answers and the IaC it ships, a raw-content URL example, and common questions mapped to existing pages.
  • Root blueprint.yaml removed — llms.txt replaces it as the pattern catalog. validate-package.py and the skill-package-validate hook no longer read it. The skill package's own copy (skills/vpc-lattice-blueprints/assets/blueprint.yaml) stays until the package is retired, and is checked only against the hash in the package README.
  • SKILLS.md — How to use this blueprint trimmed to pointers to llms.txt and AGENTS.md; the restated version pins and conventions are gone so they can no longer drift. The VPC Lattice knowledge and quick-reference facts are unchanged, and the section heading is kept.
  • CONVENTIONS.md — §9 becomes Catalog and agent-index synchronization (which indexes change together, the facts SKILLS.md still restates, the role of AGENTS.md) and documents the file paths linked from outside the repository; §7 no longer references blueprint.yaml.
  • README.md, CONTRIBUTING.md — reference llms.txt, AGENTS.md, and the new templates.
  • PR template (new) — adapted from AWS Cloud WAN Blueprints: per-area checklists for new patterns, pattern updates, the auth toolkit and agent knowledge, plus checks that llms.txt reflects added/removed/renamed pages, externally linked files are not renamed without calling it out, and AGENTS.md reflects convention or validation changes.
  • Issue template (new) — Unexpected agent output, adapted from Cloud WAN's unexpected-policy-output template, for an agent that recommended the wrong pattern, misstated VPC Lattice behaviour, or produced broken IaC.

SKILLS.md and skills/ stay in place until the skill is published; removing them, the package's blueprint.yaml copy, and the skill-package check is a follow-up.

Where is the change?

  • patterns/ — a new deployable pattern
  • patterns/ — an update to an existing pattern
  • patterns/4-auth_policies/ — the auth policies and signing reference toolkit
  • SKILLS.md or skills/ — agent knowledge
  • Repository docs or CI only

Checklist for every change

  • I have read CONVENTIONS.md and this change conforms to it.
  • Ran the checks that apply to a docs-only change: lychee on every touched file (0 errors, including an offline run with in-page anchor checking), validate-package.py (passes), YAML parse of ci.yml and .pre-commit-config.yaml, and the whitespace/EOF hygiene checks. The Terraform, cfn-lint and Checkov hooks don't apply; CI runs the full suite.
  • No Checkov-relevant changes (docs only).
  • llms.txt is new in this change and lists every pattern.
  • No externally linked file or heading was renamed or moved.
  • AGENTS.md is new in this change.

If the change is in SKILLS.md or skills/

  • Shared facts still match CONVENTIONS.md (DNS ranges, EKS parity exception).
  • validate-package.py passes.
  • Agent pilot — not run. The change removes repository content from SKILLS.md and replaces it with pointers; no VPC Lattice knowledge changed.

Testing

Statically validated only; nothing was deployed.

Separate what is about this repository from what is about VPC Lattice,
ahead of the skill moving to its own home:

- AGENTS.md: guide for an agent working in a local clone.
- llms.txt: remote entry point and pattern index; replaces blueprint.yaml.
- SKILLS.md: repository half trimmed to pointers; knowledge unchanged.
- CONVENTIONS.md: section 9 becomes catalog and agent-index sync, and
  documents externally linked paths.
- README.md, CONTRIBUTING.md: reference the new files and templates.
- PR template and unexpected-agent-output issue template, adapted from
  AWS Cloud WAN Blueprints.
- validate-package.py and the skill-package hook no longer read the root
  blueprint.yaml; the bundled snapshot is checked against its README hash.
@pablo19sc
pablo19sc merged commit 4b0fd25 into aws-samples:main Oct 19, 2026
58 checks passed
@pablo19sc
pablo19sc deleted the f-agents-md-llms-contract branch October 19, 2026 12:30
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