Add llms.txt and llms-full.txt for AI coding assistants#7
Merged
Conversation
Serve an llms.txt index and a condensed llms-full.txt API reference from the docs site so coding agents that read documentation generate correct flare-redact usage (current modes, transformSecret requirements, opt-in tags) instead of guessing from stale training data. README gains a short 'Using with AI coding agents' section with a copy-ready project-rules snippet.
umudhasanli
approved these changes
Jul 24, 2026
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
2 participants
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.
Adds llms.txt-standard files to the docs site so AI coding assistants pick up the current API instead of guessing from stale training data:
docs/llms.txt— index: what the library is, key generation facts (modes,transformSecretrequirement, opt-in tags), linksdocs/llms-full.txt— condensed but complete API reference: core API, options object, full detector inventory, vault/LLM/session/tool recipes, CLI, and 'rules of thumb for generated code' (e.g. scan omits values by default; core is browser-safe)CLAUDE.md/.cursor/rulessnippetEverything in llms-full.txt was written against the 1.2.0 API surface (checked against the README API index and current exports).