ManimCommunity / ManimCommunity/manim

The docs are confusing

Open
#4,909 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
40.9k
Forks
3.1k
Avg merge
3d 12h
Merged PRs (30d)
25

Description

As a first time user, the docs could use a little more explanation. As an example, the "Manim's building blocks" page. In the Creating a custom animation part, there's a lot of text explaining what to do, but not how to do it. It then shows you the complete code, including parts that weren't explained in the text, like at no point has the article explained what an updater or kwargs** are, but they're still in the finished code. a good way to change it might be to add snippets of the code as the parts of it are being introduced, then showing the whole code at the end.
In the same page, in the coordinates part, at no point is it explained how to use those coordinates, what the different color dots mean (unless you're willing to look into the code, which 1: is very confusing to a person who doesn't know how the library works yet, and 2: shouldn't be required, it should be explained in the text)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the “Manim’s building blocks” documentation page and read its “Creating a custom animation” and coordinates sections alongside their complete examples. Add incremental code snippets and explain terms such as updaters and kwargs, then document how to use the coordinates and what the colored dots represent. Done means a first-time reader can follow both examples without inspecting library code.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.