Skip to content

Commit d4dee1f

Browse files
committed
Updates from suggestions.
1 parent ebd9313 commit d4dee1f

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

gitkraken-client/experimental-features.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,25 @@ taxonomy:
77

88
---
99

10-
Coming from the icy depths of the git ocean are GitKraken Client experimental features. These are ideas we are trying out that still have alot of work ahead, but that we want to share with the world sooner.
10+
Coming from the icy depths of the Git ocean are GitKraken Client experimental features! These are ideas we are trying out that are still being worked on, but we want to share with the world sooner.
1111

1212
---
1313

1414
## Experimental Features
1515

16-
Navigate to <i class="fas fa-cog"></i><kbd><strong>Preferences</strong><i class='fa fa-caret-right'></i><strong>Experimental</strong></i></kbd> to access the experimental features menu.
16+
Navigate to <i class="fas fa-cog"></i><kbd><strong>Preferences</strong> <i class='fa fa-caret-right'></i> <strong>Experimental</strong></i></kbd> to access the experimental features menu.
1717

1818
Experimental Features are still under development - treat these as an early sneak peek at some of the new functionality we're working on at GitKraken. Experimental features may not work as intended and could be changed or removed in the future. These settings are entirely optional and can be turned off at any time.
1919

2020
If you do experience issues, or have any other feedback, please reach out to us [Contact Support](https://help.gitkraken.com/gitkraken-client/contact-support/?issue_category__customer_facing_field_=Experimental+feedback&subject=GitKraken+Client+Experimental+feedback).
2121

2222
### Git Executable
2323

24-
When this setting is enabled, GitKraken will utilize the Git executable instead of the NodeGit library for certain Git actions including fetching and committing. This may provide increased performance and compatibility with certain projects and development environments. This is a partial implentation and will only effect some aspects of Git within GitKraken - the amount of git commands using the git executable will increase with each release.
24+
When this setting is enabled, GitKraken Client will utilize the Git executable instead of the NodeGit library for certain Git actions including fetching and committing. This may provide increased performance and compatibility with certain projects and development environments. This is a partial implementation and will only affect some aspects of Git within GitKraken Client - the amount of Git commands using the Git executable will increase with each release.
2525

26-
**Use Git Executable:** turn on this experimental feature! As soon as you check the box it is working.
26+
**Use Git Executable:** <i class="fa-regular fa-square-check"></i> turn on this experimental feature! Check the box to immediately apply the setting.
2727

28-
**Git Executable:** We automatically include git with GitKraken. You can select other from other versions that are installed on your system.
28+
**Git Executable:** We automatically include Git with GitKraken Client. You can select other from other versions that are installed on your system.
2929

3030
##### Features using the Git Executable
3131

@@ -43,13 +43,13 @@ Find below a list of features using the Git binary if the Git Executable experim
4343

4444
### AI Commit Message Generation
4545

46-
With this setting enabled, GitKraken will have the ability to generate commit messages from any staged changes. You can access this feature from the Command Palette (⌘P/Ctrl P, or the magic wand icon () in the toolbar), or you can click the sparkle icon () in the commit panel when you have staged changes.
46+
With this setting enabled, GitKraken Client will have the ability to generate commit messages from any staged changes. You can access this feature from the Command Palette (⌘P/Ctrl P, or the magic wand icon () in the toolbar), or you can click the sparkle icon () in the commit panel when you have staged changes.
4747

4848
<div class='callout callout--danger'>
4949
<p> This feature requires sending a diff of your code changes to OpenAI. Ensure your code does not contain sensitive information before generating a commit message.</p>
5050
</div>
5151

52-
**Generate Commit Messages with AI:** turn on this experimental feature! As soon as you check the box it is working.
52+
**Generate Commit Messages with AI:** <i class="fa-regular fa-square-check"></i> turn on this experimental feature! Check the box to immediately enable the setting.
5353

5454
**OpenAi Api Key:** Your key generated by OpenAI. GitKraken Client uses `gpt-3.5-turbo` model for generating commit messages
5555

@@ -64,7 +64,7 @@ Once you have AI commit message generation enabled you will see ✨ sparkles ✨
6464
Once the commit message has been generated, you can still fully edit the message before committing. You can also click the ✨to have OpenAI try again.
6565

6666
<div class='callout callout--danger'>
67-
<p> Be aware that using OpenAI/chatGPT has a cost. At the time of this writing it is $.10 per message, and with a trial account you get $5.00 free to start.</p>
67+
<p>Be aware that using OpenAI/chatGPT has a cost. At the time of this writing, the maximum cost per request is about $0.02. OpenAI offers free trial accounts with $5.00 of credit to get started.</p>
6868
</div>
6969

7070
#### More about OpenAI
@@ -75,5 +75,5 @@ https://chat.openai.com/auth/login
7575
OpenAI's overview and documentation pages to learn more about how it works:
7676
https://platform.openai.com/
7777

78-
To specifically generate an API key for GitKraken to use:
78+
To specifically generate an API key for GitKraken Client to use:
7979
https://platform.openai.com/account/api-keys

0 commit comments

Comments
 (0)