Skip to content

Conversation

@kolibril13
Copy link
Member

As title.
One more chapter for the docs

@kolibril13 kolibril13 added the documentation Improvements or additions to documentation label Oct 12, 2020
@kolibril13 kolibril13 marked this pull request as ready for review October 12, 2020 18:13
@kolibril13
Copy link
Member Author

I think we should reduce example_scenes/basic.py to only 3 very nice looking examples and get rid of the rest.
Also in this PR, I think now every example are super necessary.
What do you think, which one should be removed?
See here:
https://manimce--538.org.readthedocs.build/en/538/examples/neat_projects.html

@kolibril13 kolibril13 requested a review from behackl October 12, 2020 18:23
@eulertour
Copy link
Member

The name of the page doesn't make sense for these; they aren't projects.

@kolibril13
Copy link
Member Author

I partly agree on that.
I thought they are small projects, that users can discover easily.
But what would be alternatives, @eulertour ?
Maybe somethink like "Manim Overview"?
Or "Basic Scenes"
But I think neat projects is a good title when we would add one sentence like:
"In this section you can see some scenes that will help you to get to know manim in several contexts"

@eulertour
Copy link
Member

Since we don't have any projects listed yet we can just rename it to "Examples" and create a projects page when we've decided on some to showcase.

@kolibril13
Copy link
Member Author

Since we don't have any projects listed yet we can just rename it to "Examples" and create a projects page when we've decided on some to showcase.

As Examples is already the chapter name, I don't like the subchapter to have the same name.
See here:https://manimce.readthedocs.io/en/latest/examples.html
I would be also fine with "Demonstration of manim", "Our Favorite Scenes".

And I just had the idea of a new section called "Release Highlights" for new features, that are not possible in the 3b1b version

@leotrs
Copy link
Contributor

leotrs commented Oct 13, 2020

What is the difference between the current "neat projects" and "advanced examples"? I think we can put these under "advanced" for now.

and renamed shapes_images_positions.rst
@eulertour
Copy link
Member

This is fine for now but we should update it with examples that are advanced when we find some.

@leotrs leotrs merged commit 24d5267 into master Oct 15, 2020
@leotrs leotrs deleted the one_more_example_chapter branch October 15, 2020 01:42
@eulertour
Copy link
Member

I didn't realize you were taking the examples out of examples/basic.py. Those provided a quick way to see how updaters and tex rendering worked, so they should be replaced.

@leotrs
Copy link
Contributor

leotrs commented Oct 17, 2020

Uuuh I didn't realize this either. @kolibril13 next time please add a more precise description of all changes you are making. In order to do this, I suggest you use the PR template.

Also, @reviewers (me included), let's pay more attention to what we are reviewing 😅

@kolibril13
Copy link
Member Author

I think we should reduce example_scenes/basic.py to only 3 very nice looking examples and get rid of the rest.

I interpreted the thumbs up as a sign that this would be ok. But alright, I will add them back! :)
see here: #564

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants