Skip to content

Conversation

@TylerBarnes
Copy link
Collaborator

@TylerBarnes TylerBarnes commented Feb 7, 2025

I noticed some llm hallucinations and it made me wonder if maybe llms.txt is outdated.
Regenerating it locally showed it was really out of date.
So I added a GH action here that will test in every PR to make sure llms.txt was regenerated. If it hasn't been the action will fail and it'll echo instructions on how to regenerate

EDIT: also had to regen llms.txt so that the new action will pass in this PR

@changeset-bot
Copy link

changeset-bot bot commented Feb 7, 2025

⚠️ No Changeset found

Latest commit: a100978

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

@vercel
Copy link

vercel bot commented Feb 7, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
assistant-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 2:36am
bird-checker ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 2:36am
crypto-chatbot ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 2:36am
mastra ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 2:36am
mastra-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 2:36am
openapi-spec-writer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 7, 2025 2:36am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
travel-ai ⬜️ Skipped (Inspect) Feb 7, 2025 2:36am

@TylerBarnes TylerBarnes changed the title docs: add test to ensure alms.txt is always up to date docs: add test to ensure llms.txt is always up to date Feb 7, 2025
@promptless
Copy link

promptless bot commented Feb 7, 2025

📝 Documentation updates detected! You can review documentation updates here

                        Promptless's comment below: 

I've created a new documentation file about maintaining docs, which includes information about the llms.txt file and the process for regenerating it. This file will help contributors understand:

  1. What llms.txt is and why it's important
  2. How to regenerate it when needed
  3. The GitHub Action that enforces this requirement
  4. General documentation maintenance guidelines

The file is placed in the contributing section of the docs, which is the most appropriate location for this type of development process documentation. The content is comprehensive but concise, focusing on practical steps while also providing context about why these steps are necessary.

No other documentation updates appear necessary for this PR, as it's primarily an infrastructure change that only affects contributors. The new documentation file adequately covers the process and requirements introduced by the GitHub Action.

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