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

Improve the Examples section of the documentation #141

Closed
4 tasks
Tracked by #5
RobPasMue opened this issue Sep 29, 2022 · 0 comments · Fixed by #164, #173, #181 or #183
Closed
4 tasks
Tracked by #5

Improve the Examples section of the documentation #141

RobPasMue opened this issue Sep 29, 2022 · 0 comments · Fixed by #164, #173, #181 or #183
Assignees
Labels
documentation Improvements or additions to documentation PRIORITY Issue/PR assigned with this tag must be given priority over the rest of the backlog

Comments

@RobPasMue
Copy link
Member

RobPasMue commented Sep 29, 2022

We should include new examples that:

  • Show how the Design object works
  • 3D visualization of objects (after Add plotting of bodies and components #135 is merged)
  • Explain the different operations that can be done with the Body and Component objects
  • Demonstrate the download/save capabilities
@RobPasMue RobPasMue changed the title Examples Improve the Examples section of the documentation Sep 29, 2022
@RobPasMue RobPasMue added the PRIORITY Issue/PR assigned with this tag must be given priority over the rest of the backlog label Sep 29, 2022
@RobPasMue RobPasMue added the documentation Improvements or additions to documentation label Sep 29, 2022
@RobPasMue RobPasMue linked a pull request Oct 20, 2022 that will close this issue
3 tasks
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 PRIORITY Issue/PR assigned with this tag must be given priority over the rest of the backlog
Projects
None yet
3 participants