Skip to content

Improve docs AI readiness assets#2513

Merged
jcstein merged 3 commits into
mainfrom
gb/docs-ai-improvements
May 22, 2026
Merged

Improve docs AI readiness assets#2513
jcstein merged 3 commits into
mainfrom
gb/docs-ai-improvements

Conversation

@gbarros
Copy link
Copy Markdown
Contributor

@gbarros gbarros commented May 22, 2026

Summary

  • expand the LLM asset generator to emit canonical markdown indexes, llms-full.txt, section llms.txt files, sitemap.xml, robots.txt, an API catalog, and an agent skills index
  • add homepage metadata, JSON-LD, and HTML discovery links for agent-readable resources
  • ignore generated local public/ artifacts while preserving tracked source assets

Validation

  • yarn build
  • yarn lint (passes with existing warning in app/build/rpc/components/NodeAPIContent.tsx:144)
  • JSON parse checks for out/.well-known/api-catalog and out/.well-known/agent-skills/index.json
  • sitemap smoke check
  • agent skill SHA-256 check

Notes

  • This intentionally does not add MCP, OAuth/OIDC, WebMCP, commerce, or true HTTP Link-header support because this is a static docs site and those surfaces are out of scope for the repo.

I've ran it against a dev server to see the expected result:
image

@gbarros gbarros requested a review from jcstein May 22, 2026 13:22
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 22, 2026

🚀 Preview Deployment

Your preview is ready: https://celestiaorg.github.io/docs-preview/pr-2513/

@gbarros gbarros marked this pull request as ready for review May 22, 2026 13:51
@gbarros gbarros requested a review from Copilot May 22, 2026 13:51
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR expands the docs site’s “AI readiness” outputs by generating additional agent-consumable artifacts (LLM indexes, a full-text snapshot, sitemap/robots, and well-known discovery JSON) and by adding homepage metadata/discovery links so agents and crawlers can find those resources.

Changes:

  • Extend scripts/generate-llms.js to emit canonical .md exports, llms-full.txt, section llms.txt files, sitemap.xml, robots.txt, and well-known discovery documents.
  • Add site-level Next.js metadata + JSON-LD, and HTML discovery links for the generated agent resources.
  • Update .gitignore to avoid committing generated artifacts under public/.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 4 comments.

File Description
scripts/generate-llms.js Generates additional LLM/agent assets (markdown exports, indexes, sitemap/robots, well-known JSON).
app/layout.tsx Adds metadata/JSON-LD and <link> discovery hints for agent-readable resources.
.gitignore Ignores generated public/ artifacts while preserving tracked source assets (e.g., SKILL.md).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread app/layout.tsx Outdated
Comment thread app/layout.tsx
Comment thread app/layout.tsx Outdated
Comment thread scripts/generate-llms.js
@jcstein
Copy link
Copy Markdown
Member

jcstein commented May 22, 2026

Screenshot 2026-05-22 at 12 54 00 huge improvement from 0!

@jcstein
Copy link
Copy Markdown
Member

jcstein commented May 22, 2026

LGTM :shipit: !

@jcstein jcstein merged commit 1620a58 into main May 22, 2026
9 checks passed
@jcstein jcstein deleted the gb/docs-ai-improvements branch May 22, 2026 20:26
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.

3 participants