Repository navigation
docs: add AGENTS.md and llms.txt, retire blueprint.yaml - #19
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Prepares the repository for the Amazon VPC Lattice skill moving to its own home, where
SKILLS.mdand theskills/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 toCONVENTIONS.mdrather 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.blueprint.yamlremoved —llms.txtreplaces it as the pattern catalog.validate-package.pyand theskill-package-validatehook 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 tollms.txtandAGENTS.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 factsSKILLS.mdstill restates, the role ofAGENTS.md) and documents the file paths linked from outside the repository; §7 no longer referencesblueprint.yaml.README.md,CONTRIBUTING.md— referencellms.txt,AGENTS.md, and the new templates.llms.txtreflects added/removed/renamed pages, externally linked files are not renamed without calling it out, andAGENTS.mdreflects convention or validation changes.SKILLS.mdandskills/stay in place until the skill is published; removing them, the package'sblueprint.yamlcopy, and theskill-packagecheck is a follow-up.Where is the change?
patterns/— a new deployable patternpatterns/— an update to an existing patternpatterns/4-auth_policies/— the auth policies and signing reference toolkitSKILLS.mdorskills/— agent knowledgeChecklist for every change
validate-package.py(passes), YAML parse ofci.ymland.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.llms.txtis new in this change and lists every pattern.AGENTS.mdis new in this change.If the change is in
SKILLS.mdorskills/validate-package.pypasses.SKILLS.mdand replaces it with pointers; no VPC Lattice knowledge changed.Testing
Statically validated only; nothing was deployed.