Skip to content

ci: Implement llms.txt automation#659

Open
ahuseyn wants to merge 1 commit into
mainfrom
implement-llmstxt
Open

ci: Implement llms.txt automation#659
ahuseyn wants to merge 1 commit into
mainfrom
implement-llmstxt

Conversation

@ahuseyn
Copy link
Copy Markdown
Member

@ahuseyn ahuseyn commented May 14, 2026

Description

llms.txt is a convention for exposing structured, LLM-readable documentation for AI tools and coding agents.

This PR adds a GitHub Actions workflow that automatically regenerates llms.txt and commits it to the PR branch whenever a pull request touching relevant files is opened or updated. Reviewers always see the final output as part of the changes before merge. Fork PRs are safely skipped. Manual runs are also supported via workflow dispatch.

The generation script is also added alongside the workflow file. The script generates llms.txt at the repo root by crawling the plugins, packages, docs, and examples directories and building a structured markdown index of links with descriptions. For each entry it extracts a title and description from the relevant README or index.md, then writes formatted bullet-point entries pointing back to the source files on GitHub.

Related Issue

#461

Dependant PRs

Type of Change

  • ✅ Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to change)
  • 🧹 Code refactoring (no functional changes)
  • 📄 Example update (no functional changes)
  • 📝 Documentation update
  • 🔍 Performance improvement
  • 🧪 Test update

How Has This Been Tested?

Screenshots

Checklist

  • I have read the CONTRIBUTING document
  • My code follows the project's coding standards
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (if applicable)
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works (if applicable)
  • Any dependent changes have been highlighted, merged or published

…omation

Co-authored-by: Copilot <copilot@github.com>
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 14, 2026

⚠️ No Changeset found

Latest commit: 24c45aa

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-project-automation github-project-automation Bot moved this to 🆕 Backlog in Headless OSS May 14, 2026
@ahuseyn ahuseyn self-assigned this May 14, 2026
@ahuseyn ahuseyn moved this from 🆕 Backlog to 👀 In review in Headless OSS May 14, 2026
@ahuseyn ahuseyn marked this pull request as ready for review May 14, 2026 13:23
@ahuseyn ahuseyn requested a review from a team as a code owner May 14, 2026 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

1 participant