docs: updated AI Element local git storage#315
Conversation
adi-wan-askui
left a comment
adi-wan-askui
left a comment
There was a problem hiding this comment.
Solid work. Like the structure and clarity (where I did not comment otherwise).
|
|
||
| AI Elements can be version controlled and shared across team members using Git. Here's how to set it up: | ||
|
|
||
| ### Current Behavior |
There was a problem hiding this comment.
I think
| ### Current Behavior | |
| ### Default Behavior |
would be clearer
|
|
||
| ### Configuration Steps | ||
| 1. Create a folder in your Git project called `<project>/ai-elements` | ||
| 2. Update your `askui_example/helpers/askui-helper.ts`: |
There was a problem hiding this comment.
| 2. Update your `askui_example/helpers/askui-helper.ts`: | |
| 2. Update your `<project>/helpers/askui-helper.ts`: |
| ```typescript | ||
| beforeAll(async () => { | ||
| aui = await UiControlClient.build({ | ||
| // ... existing configuration ... | ||
| aiElementArgs: { | ||
| additionalLocations: [ | ||
| "./ai-elements/" // Add your local AI Element location here | ||
| ] | ||
| } | ||
| }); | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
I would add more of the // ... existing configuration ... around the code to indicate everywhere where there may be other code and point out that the user has to find wherever UiControlClient.build is called and add it there
| 1. Open `askui-shell` | ||
| 2. Get the global AI Element location: | ||
| - Run `AskUI-ShowAIElement` | ||
| - Copy the path from the Image File | ||
| 3. Open the path in File Explorer | ||
| 4. Copy all files from the Global AI Element Location to your Project AI Element Location | ||
| 5. Add and commit the files to Git |
There was a problem hiding this comment.
I think this would not be 100% clear to me as a user. I think adding example output of the command AskUI-ShowAIElement and maybe shell commands for copying or screenshots of file explorer may do some good so it is easier to follow.
There was a problem hiding this comment.
Yes actually very true! I need to update this
2 participants
It was made possible to store Ai elements locally & with that also able to push to git.