Add tips in docs#5566
Conversation
|
|
|
@maryamhonari or @jrupert-unity can you have a look at this PR? Seems reasonable since it's a doc update. |
There was a problem hiding this comment.
Changes make some good improvements, but need work.
I would remove the change around line 234.
I'd remove line 270 and change 272&273 to use actionBuffers.ContinuousActions[]. Same with 319&320.
Line 264 should say ContinuousActions[] or actionBuffers.ContinuousActions[].
Line 443 should be "Make sure the behavior name in the 'Behavior Parameters' component matches the one in the config file." to fix spelling and punctuation.
|
Hey I am very new to OS contributions. I cannot see any options to edit the code in my pull request. |
|
I think if you push more changes to the file the pull request will update. Alternatively if Miguel approves we can accept this pull request and I can update with my changes after that.
|
|
Alright, I'll do that Edit: done |
|
Thanks for improving our docs! Your PR will be integrated as part of #6298. Note that the documentation in the |
* This PR addresses open PRs about ML-Agents documentation. The `docs` directory is not used anymore. Updates were done to files in `com.unity.ml-agents/Documentation~`. The files in `docs` were removed, except for redirecting to the updated documentation. The following PRs are integrated: #5705 fix typo #6184 Missing reference in code example (doublon of #5705) #5566 Add tips in docs #6110 Update Installation.md The following PRs were already fixed: #6205 Updated Readme.md to have the correct link to the CODE_OF_CONDUCT.md #6148 fix: invalid image path This PR also fixes some typos, including one found in #5646.
Proposed change(s)
I updated a code block and added little tips to explain things better, ones I wish were included when I was first learning from the docs.
Types of change(s)
Checklist
Other comments