ManimCommunity / ManimCommunity/manim
CLI: `manim init` vs `manim new` + documentation!
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 40.9k
- Forks
- 3.1k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 25
Description
## Enhancement proposal
The dialog for creating a new project spawned using our CLI with `manim new` is actually pretty cool -- but unfortunately more or less completely undocumented. This should be changed, for example by rewriting the project creation part of the quickstart tutorial.
Moreover, I am not quite sure why we have both `manim new` and `manim init`, which seems to do a pretty similar thing.
- [x] Deprecation of `manim new` + moving functionality to `manim init`
- [ ] Documenting the new utility in form of a tutorial (or by rewriting the quickstart tutorial)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the project-creation section of the quickstart tutorial and inspect the current `manim init` utility. Update the tutorial or add a dedicated tutorial explaining project creation, and ensure the documentation reflects that `manim new` was deprecated in favor of `manim init`.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100