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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 114 commits into
base: develop
Choose a base branch
from
Open

Copy docs to package #6232

wants to merge 114 commits into from
+8,493 −231

Conversation

maryamziaa
Copy link
Contributor

@maryamziaa maryamziaa commented Aug 1, 2025 •
edited
Loading

Proposed change(s)

Copy the documentation from the webpage into the package and modify it to be compatible with the package format. 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

maryamziaa added 30 commits July 22, 2025 13:02
@maryamziaa
Move all files from the extension package to the main package
509a4bf
@maryamziaa
Update the extension tests
440743f
@maryamziaa
Remove the duplicate condition
3bce3bd
@maryamziaa
Remove the duplicate condition
1f97457
@maryamziaa
Remove duplicate PhysicsMaterial
6391a89
@maryamziaa
Remove redundant import statements
da5d781
@maryamziaa
Remove Extensions meta file
befebd3
@maryamziaa
Black reformatting
886f881
@maryamziaa
Merge remote-tracking branch 'origin/develop' into merge-extensions-i…
113f39f 
…nto-ml-agents
@maryamziaa
Remove duplicate entries
9d47fe9
@maryamziaa
Move Runtime Input tests to a separate assembly
6dd1559
@maryamziaa
Move Runtime example test to Tests
bfd96c1
@maryamziaa
Update assembly
fc1db44
@maryamziaa
Update CHANGELOG.md
6cfad25
@maryamziaa
Update inputsystem version in test assembly
53f2134
@maryamziaa
Undo scene setting
3dc5882
@maryamziaa
Update the doc
f8f4c9f
@maryamziaa
Update the doc
4856cf4
@maryamziaa
Update scene setting
0150980
@maryamziaa
Update scene template
a4ab995
@maryamziaa
Update assembly
9e44c39
@maryamziaa
Change namespace to Unity.MLAgents.Input
827d56e
@maryamziaa
Remove redundant import
15ff1bb
@maryamziaa
Remove unnecessary condition
8ad46c7
@maryamziaa
Update assembly files
b3c9106
@maryamziaa
Another update
34a5098
@maryamziaa
Remove empty file
1ce9848
@maryamziaa
Copy web docs to package docs
80a9023
@maryamziaa
Unify the package doc and web doc main pages
0807316
@maryamziaa
Update image path
e66ef0b
gilescoope
gilescoope requested changes Aug 11, 2025
View reviewed changes
Copy link
Member

@gilescoope gilescoope left a comment

Choose a reason for hiding this comment

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

Looks good, just a question about the text formatting, also can't we remove the doxygen stuff?

gilescoope
gilescoope reviewed Aug 11, 2025
View reviewed changes
gilescoope
gilescoope reviewed Aug 11, 2025
View reviewed changes
@maryamziaa maryamziaa requested a review from gilescoope August 11, 2025 17:57
amanda-butler-unity
amanda-butler-unity approved these changes Aug 11, 2025
View reviewed changes
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.

Thanks so much for all of the work you put into this! It looks good to me 🎉

gilescoope
gilescoope approved these changes Aug 12, 2025
View reviewed changes
Copy link
Member

@gilescoope gilescoope left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Kristioconnor Kristioconnor Kristioconnor left review comments

@gilescoope gilescoope gilescoope approved these changes

@amanda-butler-unity amanda-butler-unity amanda-butler-unity approved these changes

@alexander-suvorov alexander-suvorov Awaiting requested review from alexander-suvorov

@montplaisir montplaisir Awaiting requested review from montplaisir

@antoine-agthe-unity antoine-agthe-unity Awaiting requested review from antoine-agthe-unity

@slunity slunity Awaiting requested review from slunity

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@maryamziaa @gilescoope @Kristioconnor @amanda-butler-unity @alexander-suvorov