[REG-1017] Walkthrough of cloning git repos and using the agent-builder #4
Conversation
REG-1017 Document how to use Behavior Trees
Let's add some initial documentation on how to use our behavior trees |
abeizer
changed the title
| ### Saving Your Tree | ||
|
|
||
| Save your tree early and often! Any changes made to your AI will be lost if you leave the Agent-Builder without saving. |
There was a problem hiding this comment.
Would it be possible to 'auto save' this on any edit/update/addition to local storage and then resolve thta with the remote on a page navigate/reload? Blockly does something like this under the covers to avoid them losing all their work
There was a problem hiding this comment.
Does this mean that blockly performs a save automatically when they leave the page, or that we cancel navigation and display some message about "hey you have unsaved changes?" Because I also thought about the latter
There was a problem hiding this comment.
if i'm remembering.. blockly auto saves locally on every edit
There was a problem hiding this comment.
I don't like that design for agent-builder because it's more complex. My experience with making behavior trees involved a lot of reswizzling my tree, trying new structures and discarding them, etc. The user should have the option of whether they want to commit their changes or decide not to if they end up not liking them
| Our platform detects changes to your AI as soon as you push them to GitHub, which allows your AI to refresh itself and display new behaviors in real-time. | ||
| The majority of our development tools rely on access to GitHub and therefore will be unavailable to users without a valid account linked to Regression Games. | ||
|
|
||
| However, we do offer alternatives to users who prefer not to use GitHub such as [uploading your AI as a .zip file](TODO-REG-1023:-Add-section-and-link-here). |
There was a problem hiding this comment.
Random musing.... I bet we could get to where zip vs github were possible for any bot type.
There was a problem hiding this comment.
For blockly and agent-builder I'm imagining a "download as zip" option in the client or something
There was a problem hiding this comment.
in prior chats, @vontell and I had discussed maybe having the client 'build' the zip dynamically.. I was thinking that in combination with the local storage would allow us to manage uploading/downloading from a zip and the user would still have a seamless experience for blockly/BTs/etc
I considered this, and I'm inclined to keep them for now. If the UI changes drastically, we can decide at that point whether to scrap them or update them because I do think they'll help new users with the current state of the client. A neat goal for our UI would be to achieve flows that don't require as many screenshots in the documentation for brand new users to understand them. If they can navigate the site just by reading simple instructions like "Go to the Bot Manager and load the Agent-Builder" then that'd be great. Right now there are small things in our flow that just aren't intuitive, like the github app stuff when you clone a template (I think this isn't too awful for now because we expect current users to have some experience with programming, but when we branch out to beginners it could be very confusing for them), or the fact that agent-builder trees don't automatically load if you open an existing tree from the bot manager (you need to click a button to request the config from github...). |
| # Creating AIs Using the Agent-Builder |
There was a problem hiding this comment.
We probs don't need the dash between Agent and Builder
| *You can report bugs and request additional features for the Agent-Builder [here](https://regression-games.sleekplan.app/feedback).* | ||
|
|
||
| ## What Is a Behavior Tree? |
There was a problem hiding this comment.
I forget if "is" should be capitalized here
There was a problem hiding this comment.
The word "Is" should be capitalized in titles
Looking for feedback on anything important I missed, anything that needs more explanation, etc.
Video of me scrolling through the page slowly, so you can pause to read the webpages instead of the markdown:
https://www.loom.com/share/9d43f9d24baa46cc9b7b9057c339ac02