Open
Conversation
Fix incorrect parameter names (anchor_01/anchor_02 → anchor1/anchor2), wrong response field reference (Time → durationSeconds), broken anchor link, unnecessary sudo, and replace 120-line failure example with a concise successful one. Add specific hardware guidance in a warning admonition.
The plugin config referenced non-existent paths (docs/api/**, docs/learn/**) causing it to silently fall back to unfiltered defaults. Changes: - Disable llms.txt generation (will be replaced by hand-crafted static file) - Fix include ordering to follow logical reading order - Enable excludeImports and removeDuplicateHeadings for cleaner output - Set proper title and description for the llmstxt.org standard header Refs: ethersphere/DevRel#839
Create static/llms.txt — a curated, llmstxt.org-compliant index that helps AI agents quickly find relevant Swarm documentation. Organised into 8 task-oriented sections (install, configure, upload, host, build, concepts, reference, optional) covering 75 doc pages. Add scripts/validate-llms-txt.mjs that runs during prebuild to detect stale links and missing coverage, keeping llms.txt in sync as docs evolve.
Copy openapi/Swarm.yaml to static/openapi.yaml during prebuild so the machine-readable API spec is served from docs.ethswarm.org/openapi.yaml. Add <link rel="api-description"> tag for automated discovery and update llms.txt to reference the local URL.
✅ Deploy Preview for test-twitter-preview-testing-3 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
1 participant
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.
Summary
Closes ethersphere/DevRel#827.
Serves the Bee OpenAPI spec as a static file at
docs.ethswarm.org/openapi.yamlso AI agents and tooling can discover and consume the machine-readable API definition directly from the docs site.Changes
package.json— Prebuild step copiesopenapi/Swarm.yaml→static/openapi.yamldocusaurus.config.mjs— Adds<link rel="api-description" href="/openapi.yaml">to HTML head for automated discoverystatic/llms.txt— OpenAPI spec link now points to local URL instead of GitHub raw.gitignore— Excludes the generatedstatic/openapi.yamlcopyHow it stays in sync
The
openapi/Swarm.yamlfile (used by Redocusaurus for the/api/page) is the single source of truth. The prebuild copy ensures/openapi.yamlalways matches what/api/renders — no extra sync step needed.Test plan
npm run buildsucceeds,openapi.yamlpresent inbuild/<link rel="api-description" href="/openapi.yaml" type="application/openapi+yaml">curl localhost:3333/openapi.yamlreturns valid YAML afternpx docusaurus serve🤖 Generated with AI