Skip to content

Conversation

@reatlat
Copy link

@reatlat reatlat commented Dec 18, 2025

PR Description

Summary

  • Add llms.txt and llms-full.txt generator following the llms.txt specification
  • Implement Lume plugin that auto-generates LLM-optimized documentation on every build
  • Output files to /documentation/llms.txt and /documentation/llms-full.txt

What this enables

AI assistants (ChatGPT, Claude, Copilot, etc.) can now ingest documentation directly, giving users better answers when asking about CloudCannon. Instead of hallucinating or giving outdated info, LLMs can reference actual docs.

Two output formats:

File Purpose
llms.txt Structured index with descriptions and links - quick reference
llms-full.txt Complete documentation content - comprehensive context

Technical details

  • Hooks into Lume's afterBuild event
  • Collects all published articles, guides, and changelogs
  • Strips JSX components and HTML while preserving content
  • Sorts by collection priority (guides > articles > changelogs)
  • Limits changelog entries to 50 in summary file to keep it focused

Test plan

  • Run deno task build and verify files generate in _site/documentation/
  • Check llms.txt has proper markdown structure with links
  • Check llms-full.txt contains full article content
  • Verify file sizes are logged during build

Works perfectly on my machine. But it runs on coffee, deadlines, and self-belief, so no guarantees ☕✨

@reatlat
Copy link
Author

reatlat commented Dec 18, 2025

output examples:

@rycoll
Copy link
Contributor

rycoll commented Dec 22, 2025

@reatlat thank you for your contribution ✨ FYI we're currently mid-way through a redesign of our documentation, and our documentation team is currently on holiday. I'll get them to check in on this once they're back, and we can make sure it's not going to need any major tweaking in the near future!

@reatlat
Copy link
Author

reatlat commented Dec 24, 2025

Hey @rycoll, appreciate the update! 🙌

No rush at all, the plugin is pretty self-contained and doesn't mess with your existing docs structure. It just hooks into afterBuild and generates the txt files from whatever content is already there. So any redesign should work seamlessly, the plugin will just pick up the new structure automatically.
Feel free to have the team poke around the code when they're back from holidays. Always happy to tweak if needed!

Merry Christmas and happy holidays! 🎄🧃

@reatlat
Copy link
Author

reatlat commented Jan 26, 2026

Hey team! 👋 Hope 2026 is off to a great start!

Just popping in to check if the docs redesign dust has settled. This little plugin is still here, patiently waiting like a well-behaved PR 🐕

No pressure, just curious if it's still on the radar or if you'd like any changes. Happy to tweak, update, or accept a "thanks but no thanks" — any response works! 😄

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.

2 participants