Skip to content

Improve Documentation#23

Merged
SkowronskiAndrew merged 4 commits intomainfrom
doc-reorg
Apr 17, 2025
Merged

Improve Documentation#23
SkowronskiAndrew merged 4 commits intomainfrom
doc-reorg

Conversation

@SkowronskiAndrew
Copy link
Copy Markdown
Collaborator

Reorganize the main Readme so that it emphasis the most important information.

Move discussion of TypeTrees to a dedicated topic, and expand out to discussion Player and AssetBundle builds.

Add more examples and some missing arguments to the UnityDataTool command line topic. Reorganize so that the experimental reference command is listed last.

Fix a few errors and typos (and hopefully not introduce a few new ones)

The command line tool is the primary usage, so try to promote
information as first thing that is emphasised, while retaining
all the other information for people who want to get deeper.

Move the TypeTree information to a dedication page (which
may expand a lot over time)

Also a few corrections.
-Add more information about the commands that are available (including some missing arguments).
-Add screenshot of the way to turn on typetrees for player builds.
New section about correlating back to source asset
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

README.md:60

  • Check the encoding or spelling of the author's name 'Francis Pag�' to ensure it displays correctly.
This tool is the evolution of the [AssetBundle Analyzer](https://github.com/faelenor/asset-bundle-analyzer) written by [Francis Pag�](https://www.github.com/faelenor).

Comment thread UnityDataTool/README.md Outdated
Comment thread README.md Outdated
Fix typos detected by copilot

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@SkowronskiAndrew SkowronskiAndrew merged commit c7f190b into main Apr 17, 2025
1 check passed
@SkowronskiAndrew SkowronskiAndrew deleted the doc-reorg branch May 6, 2025 21:38
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.

2 participants