ManimCommunity / ManimCommunity/manim-website

Add documentation on how to contribute examples to the website.

Open
#50 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue hacktoberfest
Dominant language
JavaScript
Stars
17
Forks
13
PR merge metrics
No merged PRs in 30d

Description

I think as the library grows and as we acquire new contributors and users, the landing page should also reflect that by adding better examples.

Adding some docs on adding examples would be nice 😄.

Contributor guide

No contributing guide indexed for this repository

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

The issue identifies the landing page and a need for contributor guidance, but names no file, test, or entry point. Start by locating the website's example structure and contribution guidance, then document how to add examples and verify that the instructions are sufficient for a newcomer.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.