Skip to content

Conversation

@critesjosh
Copy link
Contributor

@critesjosh critesjosh commented Aug 14, 2025

Adds a plugin to the docs to autogenerate an llms.txt file and an llms-full.txt file to be published with the docs site according to the standards defined at https://llmstxt.org/.

Also adds page descriptions to pages that are missing them, since this helps with generating the llms.txt.

Note that this is set up to generate the file for the first versioned defined in the versions.json file, which should be the default version for the docs site.

Also removes an outdated sandbox features page.

closes: AztecProtocol/dev-rel#597

@socket-security
Copy link

socket-security bot commented Aug 14, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addednpm/​docusaurus-plugin-llms@​0.1.57910010087100

View full report

@critesjosh critesjosh marked this pull request as ready for review August 15, 2025 21:33
@critesjosh critesjosh requested a review from a team August 15, 2025 21:33
@AztecBot AztecBot enabled auto-merge August 15, 2025 21:54
@critesjosh critesjosh disabled auto-merge August 16, 2025 11:41
@critesjosh critesjosh marked this pull request as draft August 16, 2025 11:41
@critesjosh critesjosh removed the request for review from a team August 16, 2025 11:41
@critesjosh
Copy link
Contributor Author

looks like some page descriptions still need to be updated

@critesjosh critesjosh marked this pull request as ready for review August 18, 2025 14:37
@critesjosh critesjosh requested review from a team and alejoamiras August 18, 2025 14:38
@AztecBot AztecBot enabled auto-merge August 18, 2025 14:46
@critesjosh critesjosh disabled auto-merge August 18, 2025 15:28
Copy link
Contributor Author

Choose a reason for hiding this comment

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

removing this because it is the same page as docs/docs/developers/guides/smart_contracts/writing_contracts/call_contracts.md

Copy link
Contributor

@alejoamiras alejoamiras left a comment

Choose a reason for hiding this comment

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

Other than some formatting issue (some changes from ' to " and some tables) the PR looks straight forward, and pretty kewl 🔥

Comment on lines +142 to +147
| Error | Cause | Solution |
| ------------------------------------ | --------------------- | ------------------------------------------ |
| `tree root mismatch` | State inconsistency | Restart sandbox or check state transitions |
| `next available leaf index mismatch` | Tree corruption | Verify tree updates are sequential |
| `Public call stack size exceeded` | Too many public calls | Reduce public function calls |
| `Failed to publish block` | L1 submission failed | Check L1 connection and gas |
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this claude's work on formatting or yours? just want to double check that all format changes are intended (applies to some other files).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i believe its my formatter, not claude

@AztecBot AztecBot added this pull request to the merge queue Aug 18, 2025
@alejoamiras alejoamiras removed this pull request from the merge queue due to a manual request Aug 18, 2025
@critesjosh critesjosh added this pull request to the merge queue Aug 18, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 18, 2025
@critesjosh critesjosh added this pull request to the merge queue Aug 18, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 18, 2025
@critesjosh critesjosh enabled auto-merge August 18, 2025 18:16
Adds a plugin to the docs to autogenerate an llms.txt file and an llms-full.txt file to be published with the docs site according to the standards defined at https://llmstxt.org/.

Also adds page descriptions to pages that are missing them, since this helps with generating the llms.txt.

Note that this is set up to generate the file for the first versioned defined in the versions.json file, which should be the default version for the docs site.

Also removes an outdated sandbox features page.
@critesjosh critesjosh added this pull request to the merge queue Aug 18, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Aug 18, 2025
@critesjosh critesjosh added this pull request to the merge queue Aug 18, 2025
Merged via the queue into next with commit b20e8bc Aug 18, 2025
15 checks passed
@critesjosh critesjosh deleted the jc/docs/llmstxt branch August 18, 2025 21:17
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.

Set up docusaurus to generate an llms.txt file

4 participants