[REG-1293] Update Agent Builder documentation for Unity SDK

Regression-Games / RegressionDocs

Documentation site for Regression Games' games, tools, etc.

0 stars 0 forks source link

[REG-1293] Update Agent Builder documentation for Unity SDK #39

Closed abeizer closed 9 months ago

abeizer commented 9 months ago

Moved some pages into a /common directory to share between players and studios routes
Added "Agent Builder" page to studios sidebar
Updated images of Agent Builder's UI, since it has changed a bit since the last time we updated the docs
- Added new images for Unity bots
Reorganized studios sidebar a bit to make it flow more nicely
- Updated alllllll the links... this was killer

RG-nAmKcAz commented 9 months ago

Is there a loom with the new content ?

Why did we drop the top level Unity header in the sidebar ? I'm sure we will need to support other engines going forward.

RG-nAmKcAz commented 9 months ago

I think we need to make some changes to clarify or get some consistency with the language around Extract Data and Upload Generated Game Context.

Something about the word generated being there doesn't jive with me.

Maybe these 2 phrasings as a starting point so their connection is more explicit. Extract Game Context Upload Game Context

abeizer commented 9 months ago

I think we need to make some changes to clarify or get some consistency with the language around Extract Data and Upload Generated Game Context.

Something about the word generated being there doesn't jive with me.

Maybe these 2 phrasings as a starting point so their connection is more explicit. Extract Game Context Upload Game Context

I'm always for simplifying our labels + user-facing concepts. We'll have to update docs after making changes to the actual projects so they're consistent. Tagging @rcornwall-reg for Unity-side

abeizer commented 9 months ago

Why did we drop the top level Unity header in the sidebar ? I'm sure we will need to support other engines going forward.

This is what the headers previously looked llke:

"Overview" was duplicated under both "Unity" and "Unity SDK Reference", which was redundant. Once I removed one of the Overview instanced, "Unity" and "Unity SDK Reference" became redundant. If we add more tooling around Unity and need to reintroduce the header, then it's a three-line change to sidebars.js (no changes needed to routes or file structure). For now, I think this looks cleaner.

Is there a loom with the new content ?

Loom where I scroll poorly, but should be slow enough that you can pause to read through each section: https://www.loom.com/share/0c77c81dd9ad421fa4d7743c37e78d56?sid=ce8a90b6-e1c6-489c-842b-88d3c62ae00d

RG-nAmKcAz commented 9 months ago

I think we need to make some changes to clarify or get some consistency with the language around Extract Data and Upload Generated Game Context. Something about the word generated being there doesn't jive with me. Maybe these 2 phrasings as a starting point so their connection is more explicit. Extract Game Context Upload Game Context

I'm always for simplifying our labels + user-facing concepts. We'll have to update docs after making changes to the actual projects so they're consistent. Tagging @rcornwall-reg for Unity-side

Please open a task for this as the work can be done on one task to update unity/ui/doc. The screenshots will be the most 'work' of the task, but other 2 parts are 1 liner wording updates

abeizer commented 9 months ago

Upload Game Context

Added here