Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[REG-1364] Verbiage around "Unity context" agrees with client and Unity editor #44

Merged
merged 2 commits into from
Nov 2, 2023

Conversation

abeizer
Copy link
Collaborator

@abeizer abeizer commented Nov 1, 2023

  • Update Agent Builder documentation and images such that everything agrees with current wording on client components and unity editor options.
  • Removed most references to GitHub
    • There are some images that still include "Save to GitHub" and "Load from GitHub" but we'll need to re-wangjangle these docs to account for C# stuff anyway (REG-1387) so we can be more thorough at that point.
    • Commented out section on manually modifying generated code. This won't be possible for zip bots (our "officially-supported" flow) until we add an option for users to download their zipped code (REG-1386), at which point we can update + uncomment it.

Client PR: https://github.com/Regression-Games/RegressionClient/pull/333
RGBots PR: Regression-Games/RGUnityBots#85

Copy link
Contributor

@analogrelay analogrelay left a comment

Choose a reason for hiding this comment

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

One slight reword suggestion and a non-blocking comment about commenting out vs deleting content.

@@ -26,11 +26,11 @@ You can report issues and submit feature requests through our [Feedback Site](ht

## Getting Started with Agent Builder

Create a new AI from the Bot Manager and select `Agent Builder` from the list of creation options
(see the section on [Cloning a Starter Template](./starter-templates) to complete this step).
Create a new AI from the Bot Manager and select `Agent Builder` from the list of creation options,
Copy link
Contributor

Choose a reason for hiding this comment

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

While you're here, we call the button "Create Bot", so it seems odd to talk about it as "Create a new AI":

Suggested change
Create a new AI from the Bot Manager and select `Agent Builder` from the list of creation options,
Create a new Bot from the Bot Manager and select `Agent Builder` from the list of creation options,

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There's many references to "AI" throughout our documentation. It was an attempt to separate the concept of AI logic from bot records, but at this point we are referring to bots so many different ways that I think we need a dedicated task to settle on what terminology to use and update the docs to make them consistent. This isn't something we want to start doing in the Agent Builder page yet

Changes made to files other than the `agentBuilderWorkspace.json` will be overwritten when you save the tree from the Agent Builder interface.
If you plan to modify files manually, it's a good idea to create a new GitHub repository to prevent losing your work.
:::
[//]: # (TODO [REG-1386] update this section)
Copy link
Contributor

Choose a reason for hiding this comment

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

I assume this syntax is commenting this out? Can we just remove it and rely on Git history? Or, if you want to preserve it somewhere a little easier, maybe copy this old code in to REG-1386?

I generally prefer if we can avoid committing commented-out code since it adds extra noise that can quickly get out of date. If we don't address REG-1386 for six months (could happen, who knows how our priorities will shift 😄) then this noise will still be here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, those are markdown comments :-)

Removed

@abeizer abeizer merged commit b939e51 into main Nov 2, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants