Skip to content

feat(docs): llms.txt, AI Agents page and ShellDocs 0.1.17-alpha - #8

Merged
Shewart merged 2 commits into
mainfrom
feat/docs-llms-txt
Oct 20, 2026
Merged

Shewart merged 2 commits into
mainfrom
feat/docs-llms-txt

Conversation

@Shewart

@Shewart Shewart commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Docs for AI agents

  • llms.txt: /llms.txt lists every page with a one-line description, after rules for agents (Llms/agent-rules.md): use ShellIcons instead of raw SVG, Lucide names, the Blazor imports and the RZ9985 trap, click handlers on a button, Title, and the MAUI and Avalonia XAML.
  • Markdown for agents: /llms-full.txt holds every page as Markdown in one file, and any page's URL + .md returns that page.
  • Agent instruction files: AGENTS.md, CLAUDE.md, copilot-instructions.md and shellicons.mdc download from /agents/.
  • Page actions: a ⋯ menu by each page title (Copy page, View as Markdown, Open in Claude, Open in ChatGPT).
  • AI Agents page: setup tabs for Claude Code, Cursor, Copilot and other agents, with curl one-liners and prompts. It's in the sidebar and the header.

ShellDocs 0.1.17-alpha (was 0.1.11)

  • Real 404s: unknown pages answer 404 through DocsNotFound, and static exports get a 404.html.
  • Static search: search now works in static exports too.

Smaller

  • Icons page: the Browse icons page mentions Avalonia.
  • README: version lines updated and an AI-agents line added.

Breaking changes

None.

Test plan

  • Docs site builds with 0 warnings; each commit builds on its own
  • All 18 pages and their .md versions return 200; /docs/nope returns 404
  • /llms.txt, /llms-full.txt and the four agent files are served (agent files as downloads)
  • AI Agents page renders with its tabs; ⋯ page actions menu shows
  • shelldocs build with CLI 0.1.17: 19 pages, 404.html, search index, 24 llms files

Follow-ups

  • Rebuild and push the docs image after merge, then redeploy
  • Bump to ShellDocs 0.1.18 when it ships (fixes the folder titles, so the sidebar shows "MAUI (preview)" instead of "Maui")

The docs page uses ShellDocs' DocsNotFound, so unknown pages answer 404 instead of 200, and static exports get a matching 404.html. Search now also works in static exports.
Turns on ShellDocs' llms.txt support: /llms.txt and /llms-full.txt with rules for agents (Llms/agent-rules.md), every page as Markdown at its URL + .md, and AGENTS.md, CLAUDE.md, Copilot and Cursor rule files under /agents/. Pages get a Copy page / View as Markdown / Open in Claude / Open in ChatGPT menu.

New AI Agents page explains how to point coding agents at the docs. The Browse icons page now mentions Avalonia.
@Shewart
Shewart merged commit 503898a into main Oct 20, 2026
2 checks passed
@Shewart
Shewart deleted the feat/docs-llms-txt branch October 20, 2026 19:57
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