Skip to content

feat: add curated llms.txt with validation CI#1751

Merged
l-henri merged 9 commits into
starknet-io:mainfrom
omarespejel:feat/llms-txt-validation
Apr 13, 2026
Merged

feat: add curated llms.txt with validation CI#1751
l-henri merged 9 commits into
starknet-io:mainfrom
omarespejel:feat/llms-txt-validation

Conversation

@omarespejel

Copy link
Copy Markdown
Contributor

Summary

Add a production-ready, curated llms.txt for docs.starknet.io, and enforce it with a lightweight validation check.

Changes

  1. Add root llms.txt with high-signal canonical docs links and concise descriptions.
  2. Add scripts/validate_llms_txt.py to validate format, link shape, duplicates, and local path mapping.
  3. Add .github/workflows/llms-check.yml to run validation on PRs and on main updates touching llms assets.

Why

  • Curated llms.txt improves retrieval quality compared with broad auto-generated lists.
  • Mintlify supports custom llms.txt override while preserving llms-full.txt for exhaustive context.
  • Search-oriented AI crawlers use explicit bot controls and robots policy (OpenAI/Anthropic/Perplexity).

References:

Validation

  • python scripts/validate_llms_txt.py
  • Result: llms.txt validation passed: 45 links, 6 sections, no format/link errors.
  • Spot-check: all linked URLs currently return HTTP 200.

Scope

  • No robots.txt changes in this PR.
  • Focused only on llms.txt quality and guardrails.

@l-henri l-henri self-requested a review April 13, 2026 15:13

@l-henri l-henri left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@l-henri l-henri merged commit f6a00d4 into starknet-io:main Apr 13, 2026
1 check passed
@omarespejel omarespejel deleted the feat/llms-txt-validation branch April 20, 2026 16:43
@omarespejel

Copy link
Copy Markdown
Contributor Author

Thanks @l-henri !

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.

2 participants