-
-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Conversation
PR Change SummaryAdded integration documentation for llms.txt format to enhance understanding and usage of Pydantic documentation.
Added Files
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 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 |
Deploying pydantic-docs with
|
Latest commit: |
dd12dfb
|
Status: | ✅ Deploy successful! |
Preview URL: | https://2f5447bf.pydantic-docs.pages.dev |
Branch Preview URL: | https://llmstxt-docs.pydantic-docs.pages.dev |
CodSpeed Performance ReportMerging #11677 will not alter performanceComparing Summary
|
|
||
Two formats are available: | ||
|
||
- [llms.txt](https://docs.pydantic.dev/latest/llms.txt): a file containing a brief description |
There was a problem hiding this comment.
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
Change Summary
Related issue number
Checklist