Skip to content

Add LLM-friendly documentation export feature#2

Open
breitburg wants to merge 1 commit intocoredevices:mainfrom
breitburg:llms-txt-feature
Open

Add LLM-friendly documentation export feature#2
breitburg wants to merge 1 commit intocoredevices:mainfrom
breitburg:llms-txt-feature

Conversation

@breitburg
Copy link

Implements automatic generation of LLM-friendly text files during Jekyll build:

  • /llms/guides.txt: All 96 developer guides
  • /llms/api-docs.txt: C, Android, iOS, JavaScript, and Rocky.js API documentation
  • /llms/community.txt: Community tools, apps, and libraries

Features:

  • Clean markdown format with minimal metadata (title + URL)
  • Automatic Liquid tag/variable removal
  • Filters out redirect pages and stub content
  • Organized with "---" separators between pages
  • Only generates files with actual content

Architecture:

  • lib/llms_txt_builder.rb: Reusable builder module (DRY principle)
  • plugins/generator_llms_txt.rb: Jekyll generator plugin (runs at :lowest priority)

@breitburg
Copy link
Author

Should work, but api-docs.txt will have limited content in local development since the DOCS_URL environment variable isn't set and the SDK documentation ZIP files aren't available locally.

Implements automatic generation of LLM-friendly text files during Jekyll build:
- /llms/guides.txt: All 96 developer guides
- /llms/api-docs.txt: C, Android, iOS, JavaScript, and Rocky.js API documentation
- /llms/community.txt: Community tools, apps, and libraries

Features:
- Clean markdown format with minimal metadata (title + URL)
- Automatic Liquid tag/variable removal
- Filters out redirect pages and stub content
- Organized with "---" separators between pages
- Only generates files with actual content

Architecture:
- lib/llms_txt_builder.rb: Reusable builder module (DRY principle)
- plugins/generator_llms_txt.rb: Jekyll generator plugin (runs at :lowest priority)

Signed-off-by: Ilia Breitburg <ilya.breytburg@gmail.com>
@ericmigi
Copy link

hey sorry for the delay, we were busy writing new SDKs. do you think this would still work? or needs some updating for Alloy/Moddable?

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