Repository navigation
Conversation
public/llms.txt was missing 17 Stellar pages that merged after it was last generated: the 14 Confidential Token pages, Utilities - Math - Fixed-Point, and the two testnet walkthroughs (Agent Wallet, Build with the SDK). The file here is `pnpm run generate:llms-txt` output with no hand edits. Add .github/workflows/llms-txt.yml, which regenerates llms.txt and fails on any diff, so a page added without regenerating it is caught in review rather than silently missing from the index coding agents read. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
✅ Deploy Preview for openzeppelin-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+16
to
+43
| name: llms.txt is up to date | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v6 | ||
|
|
||
| - name: Setup pnpm | ||
| uses: pnpm/action-setup@v6 | ||
|
|
||
| - name: Use Node.js 22 | ||
| uses: actions/setup-node@v6 | ||
| with: | ||
| node-version: 22 | ||
| cache: "pnpm" | ||
|
|
||
| - name: Install dependencies | ||
| run: pnpm install --frozen-lockfile | ||
|
|
||
| - name: Regenerate llms.txt | ||
| run: pnpm run generate:llms-txt | ||
|
|
||
| - name: Fail on drift | ||
| run: | | ||
| if ! git diff --exit-code -- public/llms.txt; then | ||
| echo "::error file=public/llms.txt::public/llms.txt is out of date. Run 'pnpm run generate:llms-txt' and commit the result." | ||
| exit 1 | ||
| fi |
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
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.
Documentation Pull Request
Summary
public/llms.txtis the index coding agents read to find our docs. It had drifted: 17 pages that merged after it was last generated were missing from it, so an agent pointed athttps://docs.openzeppelin.com/llms.txtcould not discover them.This PR does two things:
public/llms.txt. The committed file ispnpm run generate:llms-txtoutput with no hand edits (579pages with frontmatter,0without)..github/workflows/llms-txt.yml, which regeneratesllms.txton every push tomainand on PRs touchingcontent/**,src/navigation/**,scripts/generate-llms-txt.tsorpublic/llms.txt, and fails if the result differs from what is committed.The 17 pages that were missing:
The regeneration is purely additive: 17 insertions, 0 deletions.
Why the CI check
The drift was not a one-off.
llms.txtis generated, but nothing enforced that it was regenerated when pages were added, so it fell behind silently and only surfaced when someone went looking. The new workflow means the next page added without regeneratingllms.txtfails in review instead of quietly going missing from the agent-facing index for weeks.Type of Change
Related Issues
Relates to the
stellar-contractsv0.8.0 release and the agent-facing tooling refresh that accompanies it.Checklist
pnpm run buildpnpm run checkLocal verification
Run with the repo's own pinned package manager (
packageManager: pnpm@11.1.0):pnpm install --frozen-lockfilepnpm run generate:llms-txt579pages with frontmatter,0withoutpnpm run check(biome check src/+lint:links)0 errored file, 0 errorspnpm run buildProof that the new workflow actually catches drift, both directions, run locally:
llms.txtin the tree,pnpm run generate:llms-txtfollowed bygit diff --exit-code -- public/llms.txtexits non-zero → the "Fail on drift" step fails, as intended.llms.txtcommitted, the same sequence exits 0 → the step passes.Additional Notes
I drafted this content with AI assistance and tested it before opening the PR. A full re-verification of every command, plus a blind evaluation of the related Stellar agent skills, will follow as a comment on this PR.
This is one of three related PRs refreshing the agent-facing tooling for
stellar-contractsv0.8.0; the others are inOpenZeppelin/openzeppelin-skillsandOpenZeppelin/stellar-contracts.🤖 Generated with Claude Code