Skip to content

feat(LLMs): Added llms.txt and SKILL.md for better LLMs friendliness#17762

Merged
sfanahata merged 7 commits into
masterfrom
feat/llms-txt-and-root-skill
May 14, 2026
Merged

feat(LLMs): Added llms.txt and SKILL.md for better LLMs friendliness#17762
sfanahata merged 7 commits into
masterfrom
feat/llms-txt-and-root-skill

Conversation

@sfanahata
Copy link
Copy Markdown
Contributor

@sfanahata sfanahata commented May 13, 2026

DESCRIBE YOUR PR

  • Added new script (generate-llms-txt.mjs) to generate an llms.txt file that will be available publicly on the docs site.
  • Created an new SKILL.md file that references our sentry-for-ai repo and our skills.sentry.dev site, and points to our AGENTS.md and other skill pages within the repo.

Preview: https://sentry-docs-git-feat-llms-txt-and-root-skill.sentry.dev/llms.txt

Why?
This will help LLMs have better guidance navigating our docs, as well as finding the appropriate skills and references for configuration. It will also help LLMs get the proper instructions on how to stay up to date with the latest about how Sentry works, including new features. It also directly points to https://skills.sentry.dev and the sentry-for-ai repo.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Shannon Anahata added 2 commits May 13, 2026 16:31
… that will be available publicly on the docs site. Create an new SKILL.md file that references our sentry-for-ai repo and our skills.sentry.dev site, and points to our AGENTS.md and other skill pages within the repo.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 13, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
develop-docs Ready Ready Preview, Comment May 14, 2026 7:03pm
sentry-docs Ready Ready Preview, Comment May 14, 2026 7:03pm

Request Review

Copy link
Copy Markdown
Contributor

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 2 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 66baa53. Configure here.

Comment thread scripts/generate-llms-txt.mjs
Comment thread scripts/generate-llms-txt.mjs Outdated
@sfanahata sfanahata requested a review from sergical May 13, 2026 23:44
Comment thread scripts/generate-llms-txt.mjs Outdated
Shannon Anahata and others added 4 commits May 14, 2026 11:44
Rewrote generate-llms-txt.mjs to produce both public/llms.txt and
public/md-exports/index.md from the same content blocks and doctree
walk. Removes md-overrides/index.mdx which had stale hardcoded
content (Key Features list, product description) that drifted from
the live site.

Both files now share the same description, AI instructions, agent
skills, and section listings. The only difference is platform/framework
formatting: llms.txt uses compact inline format, index.md uses the
expanded separate-sections layout.
The developer-docs build (NEXT_PUBLIC_DEVELOPER_DOCS=1) produces
doctree-dev.json instead of doctree.json. Match the pattern used by
generate-md-exports.mjs to select the right filename and origin URL.
Add null check to buildPlatformsCompact and buildPlatformsExpanded
to prevent TypeError if the platforms node is missing or filtered
out by isVisible.
@sfanahata sfanahata marked this pull request as ready for review May 14, 2026 19:52
@sfanahata sfanahata merged commit 70592cb into master May 14, 2026
19 checks passed
@sfanahata sfanahata deleted the feat/llms-txt-and-root-skill branch May 14, 2026 20:05
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