Skip to content

Copy docs to package #6232

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

Open
wants to merge 92 commits into
base: develop
Choose a base branch
from
Open

Copy docs to package #6232

wants to merge 92 commits into from

Conversation

maryamziaa
Copy link
Contributor

@maryamziaa maryamziaa commented Aug 1, 2025

Proposed change(s)

Duplicate the docs from the webpage into the package. We're planning to use Unity Package documentation as the primary developer documentation and deprecate the maintenance of web docs.

Types of change(s)

  • Bug fix
  • New feature
  • Code refactor
  • Breaking change
  • Documentation update
  • Other (please describe)

Checklist

  • Added tests that prove my fix is effective or that my feature works
  • Updated the changelog (if applicable)
  • Updated the documentation (if applicable)
  • Updated the migration guide (if applicable)

Other comments

Copy link

@amanda-butler-unity amanda-butler-unity left a comment

Choose a reason for hiding this comment

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

I left some suggested changes to fix some formatting errors. I also left some questions about whether some files should be added to the ToC.

@@ -0,0 +1,20 @@
## Package Limitations

Choose a reason for hiding this comment

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

This file isn't in TableOfContents.md. Is that intentional?

Copy link
Contributor Author

@maryamziaa maryamziaa Aug 7, 2025

Choose a reason for hiding this comment

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

This file is referred in Limitations.md which itself is in TableOfContents:

- [`com.unity.mlagents` Unity package](Package-Limitations.md)

@@ -0,0 +1,51 @@
# Unity Ml-Agents Custom trainers Plugin

Choose a reason for hiding this comment

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

This file isn't in TableOfContents.md. Is that intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is referred in index.md

- Quickly and easily add your own [custom training algorithm](Python-Custom-Trainer-Plugin.md) and/or components.

maryamziaa and others added 19 commits August 7, 2025 15:25
…s.md

Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Co-authored-by: amanda-butler-unity <96449283+amanda-butler-unity@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants