ManimCommunity / ManimCommunity/manim

Sorting out CLI documentation on the webpage

Open
#3,438 1 comment 0 reactions 0 assignees View on GitHub
new feature
Dominant language
Python
Stars
40.9k
Forks
3.1k
Avg merge
3d 12h
Merged PRs (30d)
25

Description

## Description of proposed feature
We need to take a look at our CLI documentation that we have a consistent way of documenting what is possible and when it is possible because currently we have no good overview of existing and working functionality, this should be done in tandem with reworking the CLI in which @chopan050 might be interested.

related #3322

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing CLI documentation and the related issue #3322 to inventory current and working functionality. Define a consistent way to document CLI capabilities and when they are available; done means the documentation provides a clear overview and aligns with the CLI rework.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.