Skip to content

docs: add llms.txt and Markdown agent guide - #9

Merged
sks merged 2 commits into
mainfrom
docs/llms-agent-support
Nov 13, 2026
Merged

sks merged 2 commits into
mainfrom
docs/llms-agent-support

Conversation

@sks

@sks sks commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • add a curated llms.txt linking to the developer guide, examples, exact YAML contracts, and CCE docs
  • add a clean Markdown developer guide at index.md
  • add Markdown / describedby discovery links, robots.txt, and a sitemap
  • add examples/public-repo.yml and a worked AWS Samples result with verified JSON, field explanations, and IAM/runtime boundaries

Why

Agents can navigate through a concise index and inspect authoritative YAML without parsing HTML. Developers can try a pinned public repository and understand what the resulting evidence means before adding CCE to their own code.

Validation

  • npx --yes html-validate docs/index.html
  • checked all already-published external links
  • compared the documented JSON with the actual public-repository scan artifact
  • parsed the new workflow and sitemap; verified discovery links and agent indexes
  • git diff --check

New Pages and example-file URLs will be verified after deployment.

@sks
sks merged commit bca522c into main Nov 13, 2026
5 checks passed
@sks
sks deleted the docs/llms-agent-support branch November 13, 2026 22:01
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