search

Regression-Games / RegressionDocs

Documentation site for Regression Games' games, tools, etc.
0 stars 0 forks source link

[REG-1017] Walkthrough of cloning git repos and using the agent-builder #4

Closed abeizer closed 1 year ago

abeizer commented 1 year ago

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

linear[bot] commented 1 year ago
REG-1017 Document how to use Behavior Trees

Let's add some initial documentation on how to use our behavior trees

abeizer commented 1 year ago

Some random musings....

Keeping the Screen shots up to date is going to be problematic, but they definitely make the flow easier to read/understand.

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...).