Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create llms.txt #4172

wants to merge 1 commit into from

Conversation

sanjeed5
Copy link

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

  • The PR title is descriptive enough for the changelog, and the PR is labeled correctly
  • If applicable: newly added non-private functions and classes have a docstring including a short summary and a PARAMETERS section
  • If applicable: newly added functions and classes are tested

@JasonGrace2282
Copy link
Member

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.

Copy link
Contributor

@chopan050 chopan050 left a 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.
Copy link
Contributor

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:

Suggested change
- [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.
Copy link
Contributor

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.

Suggested change
- [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
Copy link
Contributor

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.

Suggested change
```markdown

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.

3 participants