Skip to content

Restructuring the contribution page #1392

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

Closed
kolibril13 opened this issue Apr 22, 2021 · 3 comments · Fixed by #1550
Closed

Restructuring the contribution page #1392

kolibril13 opened this issue Apr 22, 2021 · 3 comments · Fixed by #1550
Labels
documentation Improvements or additions to documentation enhancement Additions and improvements in general

Comments

@kolibril13
Copy link
Member

Currently, the contribution page looks like this:
image

It's say, It could also look like this:
Contributing

  • Manim Development Process
    • manim_directive
  • Docs: Adding Docstrings
  • Docs: Adding References
  • Docs: Adding Examples
  • Docs: Adding Typehints
  • Adding Tests
@kolibril13 kolibril13 added the enhancement Additions and improvements in general label Apr 22, 2021
@jsonvillanueva
Copy link
Member

Additionally, each page should have its own separate table of contents (ToC) at the beginning of the page to quickly navigate to the corresponding sections of the page. A few pages already do this sort of ToC but since these pages are just being transitioned from GitHub wiki, they don't.

@markromanmiller markromanmiller added the documentation Improvements or additions to documentation label Apr 27, 2021
@Nikhil0504
Copy link
Contributor

Should I do this?

@Nikhil0504
Copy link
Contributor

  • Docs: Adding Docstrings
  • Docs: Adding Typehints

I think we should put them in the same page as they are related to each other and we use them side by side so we can just omit some lines and change the examples accordingly to accommodate typehints also. This way the contributor can know all the information in one page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Additions and improvements in general
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants