Skip to content

SPIKE: How to approach llms.txt for the toolkit #461

@colinmurphy

Description

@colinmurphy

Summary

Research best practices for making the toolkit's docs, plugins, and examples consumable by LLMs, and recommend an implementation approach.

Background

The llms.txt specification is an emerging standard for providing LLM-friendly project context. We should evaluate whether and how to adopt it (or similar approaches) for the toolkit.

Research areas

  • Review the llms.txt spec and existing adoptions in the wild (e.g., other open-source toolkits, WordPress projects)
  • Determine what content should be surfaced: docs (docs/), plugin READMEs (plugins/), package READMEs (packages/), examples (examples/), or a subset
  • Evaluate URL strategy — raw GitHub URLs vs. a docs site domain vs. relative paths
  • Decide whether llms-full.txt (concatenated full-text) is worth the maintenance cost
  • Assess whether the file should be hand-authored or generated as part of a build step

Deliverable

A recommendation (can be a comment on this issue or a follow-up issue) with:

  1. Proposed file structure
  2. What content to include and link to
  3. How to maintain it going forward (manual vs. automated)

Metadata

Metadata

Assignees

No one assigned

    Labels

    topic:toolkittype:ciChanges to our CI configuration files and scripts (GitHub Actions)type:docsDocumentation only changestype:researchCovers research and explorational tasks

    Type

    No type

    Projects

    Status

    🔖 Ready for Development

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions