Skip to content

Add integration documentation for llms.txt #11677

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 2, 2025
Merged

Add integration documentation for llms.txt #11677

merged 1 commit into from
Apr 2, 2025

Conversation

Viicos
Copy link
Member

@Viicos Viicos commented Apr 2, 2025

Change Summary

Related issue number

Checklist

  • The pull request title is a good summary of the changes - it will be used in the changelog
  • Unit tests for the changes exist
  • Tests pass on CI
  • Documentation reflects the changes where applicable
  • My PR is ready to review, please add a comment including the phrase "please review" to assign reviewers

Copy link
Contributor

hyperlint-ai bot commented Apr 2, 2025

PR Change Summary

Added integration documentation for llms.txt format to enhance understanding and usage of Pydantic documentation.

  • Introduced documentation for the llms.txt format used in Pydantic.
  • Provided links to both llms.txt and llms-full.txt files.
  • Explained the limitations of current LLM frameworks in leveraging these files.

Added Files

  • docs/integrations/llms.md

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

Copy link

cloudflare-workers-and-pages bot commented Apr 2, 2025

Deploying pydantic-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: dd12dfb
Status: ✅  Deploy successful!
Preview URL: https://2f5447bf.pydantic-docs.pages.dev
Branch Preview URL: https://llmstxt-docs.pydantic-docs.pages.dev

View logs

@Viicos Viicos added the backport-2.11 Needs backport to 2.11 label Apr 2, 2025
Copy link

codspeed-hq bot commented Apr 2, 2025

CodSpeed Performance Report

Merging #11677 will not alter performance

Comparing llmstxt-docs (dd12dfb) with main (6c38dc9)

Summary

✅ 46 untouched benchmarks


Two formats are available:

- [llms.txt](https://docs.pydantic.dev/latest/llms.txt): a file containing a brief description
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could use https://github.com/fralau/mkdocs-macros-plugin to dynamically build the URL from config.site_url, but it seems that this plugin treats every markdown page as a jinja template, and I'm worried this sill lead to unexpected side effects

Copy link
Contributor

github-actions bot commented Apr 2, 2025

Coverage report

This PR does not seem to contain any modification to coverable code.

@dmontagu dmontagu merged commit f70f291 into main Apr 2, 2025
64 checks passed
@dmontagu dmontagu deleted the llmstxt-docs branch April 2, 2025 21:49
Viicos added a commit that referenced this pull request Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-2.11 Needs backport to 2.11 documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants