Skip to content

docs: add llms.txt for AI-agent discoverability#97

Merged
vaaraio merged 2 commits into
mainfrom
docs/add-llms-txt
May 18, 2026
Merged

docs: add llms.txt for AI-agent discoverability#97
vaaraio merged 2 commits into
mainfrom
docs/add-llms-txt

Conversation

@vaaraio
Copy link
Copy Markdown
Owner

@vaaraio vaaraio commented May 18, 2026

Summary

Adds an llms.txt at repo root following the llmstxt.org format. Points AI agents and crawlers at the repo, packages, docs, integrations, and key external references in a single deterministic file. Same content served at https://vaara.io/llms.txt.

Test plan

Summary by CodeRabbit

  • Documentation
    • Added comprehensive compliance documentation with structured links to specifications, integration tools, cloud adapters, and governance resources.

Review Change Stack

llmstxt.org-format index pointing to repo, packages, docs, integrations,
and key external references. Same content served at https://vaara.io/llms.txt.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ea034193-a449-4a2a-8840-616485d4b564

📥 Commits

Reviewing files that changed from the base of the PR and between 0ee1ea6 and d2ecdd4.

📒 Files selected for processing (1)
  • llms.txt

📝 Walkthrough

Walkthrough

This PR adds content to llms.txt, a metadata file that documents the Vaara runtime evidence layer with structured information including repository links, package references, documentation resources, integration points, and quantitative metrics for EU AI Act compliance.

Changes

Vaara Project Metadata

Layer / File(s) Summary
Vaara project metadata in llms.txt
llms.txt
llms.txt is populated with project overview, repository and package links (PyPI, npm), documentation references (README, COMPLIANCE mapping, formal specification, benchmark, changelog, HTTP API contract, signing keys), integration points (framework adapters, cloud guardrail adapters, OVERT tooling), quantitative metrics, and optional governance resources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A metadata file so neat,
Llms.txt makes docs complete,
Vaara's compliance story told,
Links and specs in structured gold,
Evidence layer, now unfold! 🌟

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add llms.txt for AI-agent discoverability' directly and accurately summarizes the main change: adding an llms.txt file for AI-agent discovery purposes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-llms-txt

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@vaaraio vaaraio merged commit ee452b1 into main May 18, 2026
10 checks passed
@vaaraio vaaraio deleted the docs/add-llms-txt branch May 18, 2026 17:56
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