Established individual topic for each UnityDataTool command #43
+465
−195
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Remove duplicated reference section in main readme that would be hard to maintain A few edits based on review.
SkowronskiAndrew
force-pushed
the
improve_docs
branch
from
36854f6 to
6f060c8
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the UnityDataTool documentation by splitting the monolithic README into individual command-specific pages. The main README now serves as a quick reference hub with links to detailed documentation for each command (analyze, dump, archive, find-refs).
Key changes:
- Restructured README with command table and quick start examples
- Created individual markdown files for each command with detailed usage, examples, and troubleshooting
- Improved navigation with consistent formatting and cross-references
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| UnityDataTool/README.md | Condensed main README into overview with command table, quick start examples, and links to detailed docs |
| UnityDataTool/Commands/analyze.md | Detailed analyze command documentation including options, examples, troubleshooting, and performance considerations |
| UnityDataTool/Commands/dump.md | Complete dump command reference with archive support explanation and PPtr details |
| UnityDataTool/Commands/archive.md | Documentation for archive list/extract sub-commands with comparison table |
| UnityDataTool/Commands/find-refs.md | Reference finder command docs with use cases, output format explanation, and experimental warning |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| | Command | Output | Use Case | | ||
| |---------|--------|----------| | ||
| | `archive extract` | Binary SerializedFiles, .resS anything else inside the archive content | When you need all the raw files inside an archive | |
There was a problem hiding this comment.
Missing punctuation. Should be 'Binary SerializedFiles, .resS, and anything else inside the archive content' or 'Binary SerializedFiles, .resS files, and anything else inside the archive content'.
Suggested change
| | `archive extract` | Binary SerializedFiles, .resS anything else inside the archive content | When you need all the raw files inside an archive | | |
| | `archive extract` | Binary SerializedFiles, .resS files, and anything else inside the archive content | When you need all the raw files inside an archive | |
| | **Entities content** | `StreamingAssets/ContentArchives` folder for [Entities](https://docs.unity3d.com/Packages/[email protected]/manual/content-management-intro.html) projects | | ||
| | **Player Data folder** | The `Data` folder of a Unity Player build | | ||
| | **Compressed Player builds** | The `data.unity3d` file will be analyzed like AssetBundles | | ||
| | **BuildReport files** | The build report is typically found at a path like `Library/LastBuild.buildreport`and is a binary serialized file | |
There was a problem hiding this comment.
Missing space between backtick and 'and'. Should be Library/LastBuild.buildreport and is a binary serialized file.
|
|
||
| A real life analyze of a big Addressables build shows how large a difference this can make: | ||
|
|
||
| * 208 seconds and producted a 500MB database (not specifying --skip-reference) |
There was a problem hiding this comment.
Corrected spelling of 'producted' to 'produced'.
Suggested change
| * 208 seconds and producted a 500MB database (not specifying --skip-reference) | |
| * 208 seconds and produced a 500MB database (not specifying --skip-reference) |
| | `m_FileID` | Index into External References list (0 = same file) | | ||
| | `m_PathID` | Object's Local File Identifier (LFID) in that file | | ||
|
|
||
| A null reference will have value m_FileID = 0, m_PathID = 0 |
There was a problem hiding this comment.
Grammatically incorrect. Should be 'A null reference will have values m_FileID = 0, m_PathID = 0' (plural 'values').
Suggested change
| A null reference will have value m_FileID = 0, m_PathID = 0 | |
| A null reference will have values m_FileID = 0, m_PathID = 0 |
| | **Entities content** | `StreamingAssets/ContentArchives` folder for [Entities](https://docs.unity3d.com/Packages/[email protected]/manual/content-management-intro.html) projects | | ||
| | **Player Data folder** | The `Data` folder of a Unity Player build | | ||
| | **Compressed Player builds** | The `data.unity3d` file will be analyzed like AssetBundles | | ||
| | **BuildReport files** | The build report is typically found at a path like `Library/LastBuild.buildreport`and is a binary serialized file | |
Collaborator
Author
There was a problem hiding this comment.
Suggested change
| | **BuildReport files** | The build report is typically found at a path like `Library/LastBuild.buildreport`and is a binary serialized file | | |
| | **BuildReport files** | The build report is typically found at a path like `Library/LastBuild.buildreport` and is a binary serialized file | |
Collaborator
Author
SkowronskiAndrew
left a comment
SkowronskiAndrew
left a comment
There was a problem hiding this comment.
Apply typo fixes discovered by copilot review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Split up the README file for UnityDataTool so that its easier to see the list of commands
Establish more structure to the documentation comment.