Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Initial documentation #64

Merged
merged 22 commits into from
Oct 4, 2023
Merged

Initial documentation #64

merged 22 commits into from
Oct 4, 2023

Conversation

nic-barbara
Copy link
Collaborator

Added the beginning of our documentation:

  • Installation and setup instructions
  • Basic usage of the package and visualiser
  • Copied over some details from the README.md on arrays, tips/tricks, etc.
  • Added an example of balancing a cart-pole into the docs

@nic-barbara nic-barbara added the documentation Improvements or additions to documentation label Oct 4, 2023
@nic-barbara nic-barbara self-assigned this Oct 4, 2023
@nic-barbara nic-barbara linked an issue Oct 4, 2023 that may be closed by this pull request
Add installation and basic usage to the docs #63
Closed
3 tasks
@nic-barbara nic-barbara requested a review from JamieMair October 4, 2023 05:53
@codecov-commenter
Copy link

codecov-commenter commented Oct 4, 2023 •
edited
Loading

Codecov Report

Merging #64 (83a3293) into main (aec4137) will not change coverage.
The diff coverage is n/a.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

@@           Coverage Diff           @@
##             main      #64   +/-   ##
=======================================
  Coverage   25.15%   25.15%           
=======================================
  Files          21       21           
  Lines        4905     4905           
=======================================
  Hits         1234     1234           
  Misses       3671     3671
Files Coverage Δ
ext/VisualiserExt/visualiser.jl 0.00% <ø> (ø)
src/LibMuJoCo/structs.jl 0.00% <ø> (ø)
src/visualiser.jl 0.00% <ø> (ø)

@nic-barbara nic-barbara mentioned this pull request Oct 4, 2023
Closed
@JamieMair JamieMair mentioned this pull request Oct 4, 2023
Merged
JamieMair
JamieMair approved these changes Oct 4, 2023
View reviewed changes
Copy link
Owner

@JamieMair JamieMair left a comment

Choose a reason for hiding this comment

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

Great! I have made a few tweaks in #65 if you want to use them. After that, you can merge in :)

@JamieMair
Copy link
Owner

Closes #23

@nic-barbara nic-barbara linked an issue Oct 4, 2023 that may be closed by this pull request
Add in documentation for the underlying mujoco API #23
Closed
@nic-barbara nic-barbara merged commit c80dedf into main Oct 4, 2023
@nic-barbara nic-barbara deleted the docs/basic-usage branch October 4, 2023 21:51
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@JamieMair JamieMair JamieMair approved these changes

Assignees

@nic-barbara nic-barbara

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add installation and basic usage to the docs Add in documentation for the underlying mujoco API
3 participants
@nic-barbara @codecov-commenter @JamieMair