-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Create llms.txt #4172
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
base: main
Are you sure you want to change the base?
Create llms.txt #4172
Conversation
I feel like this would be something better and easier to keep up to date for Sphinx (see sphinx-doc/sphinx#13268), but they seem to not have any interest in it currently. |
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.
Thanks for the contribution! I left some comments and change requests.
|
||
## Examples | ||
|
||
- [Example Gallery](https://docs.manim.community/examples.html): A collection of code snippets and corresponding video/image outputs showcasing different Manim functionalities. |
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.
The links in this file are broken. To fix this, please add /en/stable
right after docs.manim.community
in all of them:
- [Example Gallery](https://docs.manim.community/examples.html): A collection of code snippets and corresponding video/image outputs showcasing different Manim functionalities. | |
- [Example Gallery](https://docs.manim.community/en/stable/examples.html): A collection of code snippets and corresponding video/image outputs showcasing different Manim functionalities. |
## Installation | ||
|
||
- [Installation Instructions](https://docs.manim.community/installation.html): Detailed guides for installing Manim on Windows, macOS, and Linux using various methods. | ||
- [Local Installation via pip](https://docs.manim.community/installation/uv.html): Recommended method for installing Manim using Python's package manager pip and uv for environment management. |
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.
Although we briefly mention in this link that "The standard way of installing Manim is by using Python’s package manager pip
", the method we actually recommend is using uv
and the linked page almost exclusively talks about using uv
when installing Python and Manim. Therefore, I believe that the description here should reflect that.
- [Local Installation via pip](https://docs.manim.community/installation/uv.html): Recommended method for installing Manim using Python's package manager pip and uv for environment management. | |
- [Local Installation via uv](https://docs.manim.community/en/stable/installation/uv.html): Recommended method for installing Manim using uv for environment management. |
@@ -0,0 +1,81 @@ | |||
```markdown |
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.
Is this first line necessary? Other llms.txt
files I've seen don't have it.
```markdown |
Overview: What does this pull request change?
Add's a llms.txt file for Manim. Reference: https://llmstxt.org/
Motivation and Explanation: Why and how do your changes improve the library?
I was trying to use an agent to work with Manim and thought of this
Further Information and Comments
I don't know if this is the right position for the file to be in, please comment and I"ll make necessary changes to complete this.
Reviewer Checklist