Skip to content

feat: LLM compatibility improvements & algolia update - #263

Merged
EchinopsisM merged 2 commits into
masterfrom
algolia
May 25, 2026
Merged

feat: LLM compatibility improvements & algolia update#263
EchinopsisM merged 2 commits into
masterfrom
algolia

Conversation

@EchinopsisM

@EchinopsisM EchinopsisM commented May 19, 2026

Copy link
Copy Markdown
Contributor

Summary

LLM Compatibility

  • Add description frontmatter to all documentation pages for richer search/LLM context
  • Convert absolute /docs/... links to relative .md file links for better LLM navigation
  • Add hand-crafted static/llms.txt index following the llmstxt.org standard
  • Add scripts/validate-llms-txt.mjs build-time script that cross-checks llms.txt against actual doc files
  • Configure docusaurus-plugin-llms to generate /llms-full.txt at build time
  • Add prebuild hook to run validation automatically on every build

Analogous to the changes made in bee-docs (#779, #784).

Algolia Update

  • Update Algolia config to point at a new crawler which now uses the full featured docsearch, leading to many more hits for searches (almost double on the few terms I tested)

How it works

```
npm run build
→ prebuild: validate-llms-txt.mjs (warns on stale/missing links, exits 0)
→ docusaurus build (generates /llms-full.txt via plugin)
→ static/llms.txt copied to build/ as-is
```

Test plan

  • `npm run build` succeeds, validation script runs with no warnings
  • `/llms.txt` returns the hand-crafted file
  • `/llms-full.txt` returns plugin-generated full text
  • Spot-check relative links in converted doc pages resolve correctly

@EchinopsisM
EchinopsisM requested a review from Cafe137 as a code owner May 19, 2026 09:48
…s, fix admonition styles

- Add docusaurus-plugin-llms to generate /llms-full.txt at build time
- Add static/llms.txt as hand-crafted index for AI agents
- Add scripts/validate-llms-txt.mjs to cross-check llms.txt against doc files (runs as prebuild hook)
- Convert absolute /docs/... links to relative .md links across all doc pages
- Add description frontmatter to all documentation pages
- Fix admonition (alert) background and text colors with !important to override Docusaurus scoped styles
- Extend admonition link/icon color fixes to --danger and --tip variants
- Add .claude to .gitignore

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@EchinopsisM EchinopsisM changed the title switch algolia index feat: LLM compatibility improvements May 19, 2026
@EchinopsisM EchinopsisM changed the title feat: LLM compatibility improvements feat: LLM compatibility improvements & algolia update May 25, 2026
@EchinopsisM
EchinopsisM merged commit 364b4c6 into master May 25, 2026
1 check passed
@EchinopsisM
EchinopsisM deleted the algolia branch May 25, 2026 06:50
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.

1 participant