Skip to content
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

Add basic design examples and arrange the format of example page. #183

Merged
merged 31 commits into from
Oct 21, 2022

Conversation

Revathyvenugopal162
Copy link
Contributor

@Revathyvenugopal162 Revathyvenugopal162 commented Oct 20, 2022

  • Add the layout for examples page.
  • Add basic design examples
  • add tessellation example

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 20, 2022
@RobPasMue
Copy link
Member

@Revathyvenugopal162 please get in touch with @chadqueen regarding #181 and this PR. Propose a common approach.

@Revathyvenugopal162 Revathyvenugopal162 marked this pull request as ready for review October 20, 2022 10:09
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good first attempt. Let's keep improving it. Review all examples and pay attention to the descritions. They are as important as the code we are putting in each code cell. Users should be able to understand (both from the code and the description) what you are doing in each of the cells. And be more "narrative". Try to explain what is the goal of this example, what we are targeting, what the process consists on, what features are we going to explain etc.

doc/source/conf.py Outdated Show resolved Hide resolved
doc/source/examples.rst Outdated Show resolved Hide resolved
doc/source/examples/design/add_design_material.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/add_design_material.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/add_design_material.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/plate_with_hole.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/plate_with_hole.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/tessellation_usage.mystnb Outdated Show resolved Hide resolved
@RobPasMue RobPasMue linked an issue Oct 20, 2022 that may be closed by this pull request
4 tasks
Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
Co-authored-by: Roberto Pastor Muela <roberto.pastormuela@ansys.com>
doc/source/conf.py Outdated Show resolved Hide resolved
doc/source/examples.rst Show resolved Hide resolved
doc/source/examples/design/add_design_material.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/plate_with_hole.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/plate_with_hole.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/tessellation_usage.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/tessellation_usage.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/tessellation_usage.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/tessellation_usage.mystnb Outdated Show resolved Hide resolved
doc/source/examples/design/tessellation_usage.mystnb Outdated Show resolved Hide resolved
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks @Revathyvenugopal162 for the hard work!

doc/source/examples/design/tessellation_usage.mystnb Outdated Show resolved Hide resolved
@RobPasMue RobPasMue linked an issue Oct 21, 2022 that may be closed by this pull request
5 tasks
@RobPasMue RobPasMue removed a link to an issue Oct 21, 2022
5 tasks
@RobPasMue RobPasMue linked an issue Oct 21, 2022 that may be closed by this pull request
5 tasks
Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>
@RobPasMue RobPasMue enabled auto-merge (squash) October 21, 2022 08:11
@RobPasMue RobPasMue merged commit 020c54e into main Oct 21, 2022
@RobPasMue RobPasMue deleted the docs/add-initial-examples branch October 21, 2022 08:27
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.

Improve the Examples section of the documentation Improve documentation sections
4 participants