From 7100f632ab98e95142a4ffa8474d3cd6dad59afd Mon Sep 17 00:00:00 2001 From: Jonathan Silva Date: Fri, 24 Apr 2026 14:03:37 -0400 Subject: [PATCH 1/6] docs: Add guide for updating Help Center content with Agent Sessions View --- ...center-content-with-agent-sessions-view.md | 168 ++++++++++++++++++ 1 file changed, 168 insertions(+) create mode 100644 gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md diff --git a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md new file mode 100644 index 0000000..f72a722 --- /dev/null +++ b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md @@ -0,0 +1,168 @@ +# Update Help Center content with Agent Sessions View + +Last updated: April 2026 + +Use this example to update GitKraken Desktop Help Center markdown files with a coding agent in GitKraken Desktop. Agent Sessions View is useful for documentation maintenance because it keeps the worktree, agent session, WIP changes, and pull request status together in one place. + +## Before you start + +Make sure you have the following: + +- GitKraken Desktop installed and updated to a version that includes Agent Sessions View +- Access to the Help Center docs repository on GitHub +- A coding agent configured in GitKraken Desktop, using Codex in this example +- GitHub integration connected so you can create a pull request from GitKraken Desktop + +## Open the Help Center repo in GitKraken Desktop + +Each Help Center product section is maintained in its own Git repository. Those repositories contain markdown files that are later rendered by a CMS. + +1. Open GitKraken Desktop. +2. Click the plus icon in the top left and choose **Open**. +3. Select the Help Center docs repository for GitKraken Desktop. +4. Confirm that the default worktree opens and that you can see the commit graph. + +## Create a new agent session worktree + +Agent Sessions View organizes worktrees around coding agent sessions. List view shows the same underlying worktrees, but focuses on general branch and worktree management. + +1. Open the **Agents** left panel and switch to **Agent Sessions View**. +2. Click **New agent session**. +3. Name the branch something like `token-to-credit-renaming`. +4. Choose **Codex** as the coding agent for this session. +5. Click **Start** to create a new worktree and agent session. +6. Confirm that: + - A new worktree appears in the left panel. + - The branch is checked out in the new worktree. + - The agent session is ready for instructions. + +## Ask the agent to update Gemini references + +You can describe the task to the agent in plain language. In this example, start with the Gemini naming update. + +```text +Search all .md files in this repo for mentions of +"Google Gemini Flash" or "Google Gemini 2.x Flash" +and rename them to "Google Gemini models". +``` + +The agent scans markdown files in the repository and proposes or applies edits, depending on your configuration. Before you let the agent run, validate the target phrasing so you are sure that `Google Gemini Flash` should become `Google Gemini models`. + +## Ask the agent to update token references + +Next, update billing and usage wording more carefully. In this case, you only want to rename `tokens` where the text clearly refers to GitKraken AI usage or billing. + +```text +Search all .md files in this repo for mentions of "tokens" +and change them to "credits" only in the context of +GitKraken AI usage or billing. Do not change unrelated uses +of the word "token". +``` + +The agent may touch multiple pages, including release notes and common issues pages. Review those edits closely because `token` can also appear in unrelated technical contexts. + +## Update date stamps for modified pages + +Some GitKraken Help Center pages include a `Last updated` date near the top of the page. You can use the agent to keep those dates consistent for any files it changed. + +```text +For any pages you modified that include a date stamp +at the top, update the date to "April 2026". +``` + +The agent updates the date line for each affected file. You can verify those changes in the diff view before you commit anything. + +## Review agent changes in WIP + +Agent Sessions View surfaces uncommitted edits for the current worktree in a **Work in progress (WIP)** node at the top of the graph. This makes it easy to review the full set of documentation changes produced by you or the agent. + +1. In **Agent Sessions View**, select the current session. +2. Click the **WIP** node at the top of the graph. +3. Use the right-side file list to open each modified markdown file. +4. Confirm that: + - `Google Gemini Flash` references are now `Google Gemini models`. + - `tokens` to `credits` changes only appear in GitKraken AI contexts. + - Date stamps at the top of modified pages are set to `April 2026`. + +## Stage changes and generate commits with GitKraken AI + +Once the edits look correct, stage the documentation changes and use GitKraken AI to help prepare commits. + +1. Click **Stage all changes**. +2. Use the **Generate commit message** magic wand button to create a single commit message from the staged changes, or +3. Click **Compose commits with AI** to have GitKraken AI group the changes into multiple topic-based commits. +4. Review the suggested commits and optionally squash, drop, or reword them before confirming. + +Multiple topic-based commits can help reviewers. For example, you might keep Gemini wording updates separate from `tokens` to `credits` updates and separate both from date-only edits. + +## Open a pull request from GitKraken Desktop + +After you commit the changes, open a pull request from the same worktree. Agent Sessions View keeps this workflow together so you can move from editing to review without leaving the context of the session. + +1. Push the branch to your fork or `origin` if it does not exist on the remote yet. +2. Drag and drop the feature branch onto `main` in the graph to start a pull request, or use the pull request action from the right panel. +3. Use the GitHub integration to: + - Select the repository and base branch. + - Apply the existing pull request template. + - Use GitKraken AI to generate a pull request title and description from the template and your changes. +4. Add reviewers and assignees if needed. +5. Create the pull request. + +Once the pull request exists, GitKraken Desktop shows an active PR chip in the worktree and displays pull request details in the top-right panel. + +## Merge the pull request and verify + +If you have permission, you can merge the pull request directly from GitKraken Desktop. You can also open the pull request in GitHub in your browser if your team prefers to merge there. + +1. Merge the pull request after review and approval. +2. Pull the latest changes into your local `main`. +3. Confirm that `Google Gemini models` and `AI credits` appear correctly in the updated documentation. +4. If your Help Center publishing flow requires a CMS publish step, complete that process so the changes appear live. + +## Clean up the agent worktree + +Agent Sessions View and List view both point to the same worktrees. When the work is complete, remove the temporary worktree from List view. + +1. Switch from **Agents** to **List view** in the left panel. +2. Make sure **Worktrees** is visible. If it is not, right-click a left-panel header and enable **Worktrees**. +3. Hover over the worktree you used for the agent session. +4. Right-click and select **Remove worktree**. +5. Verify that: + - The worktree disappears from the left panel. + - It is no longer available in the branch or worktree selector at the top of GitKraken Desktop. + +## Example prompts you can reuse + +Use prompts like these when you want to understand a repository before making changes, or when you want to apply the same workflow to a different set of documentation files. + +```text +Scan this repository and tell me which markdown files are most relevant +to terminology updates or documentation maintenance. Summarize what you +find before making any changes. +``` + +```text +Search markdown files for references to "Google Gemini Flash" or +"Google Gemini 2.x Flash". Show me which files would need to change +to use "Google Gemini models", then make the edits after I confirm. +``` + +```text +Search markdown files for references to "tokens" and identify which +uses appear to describe product billing, usage, or entitlements. +Change only those references to "credits" and leave unrelated uses +of "token" unchanged. +``` + +```text +For any documentation files you modified, check whether they include a +"Last updated" line near the top. Update that date consistently and +show me the affected files in the diff. +``` + +```text +Summarize the changes you made, group them into logical commit topics, +and suggest commit messages I can use for a pull request. +``` + +Reuse this workflow whenever you need to safely review, refactor, or standardize wording across multiple documentation pages with coding agents in GitKraken Desktop. Agent Sessions View helps you keep the worktree, edits, review flow, and pull request connected so the process stays repeatable. From 452a39342fb8bbe6ed2fe207084e8840aa5df8f0 Mon Sep 17 00:00:00 2001 From: Jonathan Silva Date: Fri, 24 Apr 2026 14:05:21 -0400 Subject: [PATCH 2/6] docs: Generalize example to apply to any repository documentation --- ...update-help-center-content-with-agent-sessions-view.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md index f72a722..a2af0e1 100644 --- a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md +++ b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md @@ -2,24 +2,24 @@ Last updated: April 2026 -Use this example to update GitKraken Desktop Help Center markdown files with a coding agent in GitKraken Desktop. Agent Sessions View is useful for documentation maintenance because it keeps the worktree, agent session, WIP changes, and pull request status together in one place. +Use this example to review and update repository documentation with a coding agent in GitKraken Desktop. Agent Sessions View is useful for documentation maintenance because it keeps the worktree, agent session, WIP changes, and pull request status together in one place. ## Before you start Make sure you have the following: - GitKraken Desktop installed and updated to a version that includes Agent Sessions View -- Access to the Help Center docs repository on GitHub +- Access to a Git repository on GitHub that includes markdown documentation - A coding agent configured in GitKraken Desktop, using Codex in this example - GitHub integration connected so you can create a pull request from GitKraken Desktop ## Open the Help Center repo in GitKraken Desktop -Each Help Center product section is maintained in its own Git repository. Those repositories contain markdown files that are later rendered by a CMS. +Many codebases include markdown files for setup instructions, contributor guidance, architecture notes, changelogs, or internal documentation. This example uses a repository that includes markdown docs you want to review and update so they match the current codebase. 1. Open GitKraken Desktop. 2. Click the plus icon in the top left and choose **Open**. -3. Select the Help Center docs repository for GitKraken Desktop. +3. Select the repository you want to review. 4. Confirm that the default worktree opens and that you can see the commit graph. ## Create a new agent session worktree From 147c994ffd74234efed8f33d5a3d25ee398b2a26 Mon Sep 17 00:00:00 2001 From: Jonathan Silva Date: Fri, 24 Apr 2026 14:05:21 -0400 Subject: [PATCH 3/6] docs: Generalize agent session workflow for documentation review --- ...center-content-with-agent-sessions-view.md | 66 +++++++++++-------- 1 file changed, 37 insertions(+), 29 deletions(-) diff --git a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md index a2af0e1..78eeac4 100644 --- a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md +++ b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md @@ -28,49 +28,58 @@ Agent Sessions View organizes worktrees around coding agent sessions. List view 1. Open the **Agents** left panel and switch to **Agent Sessions View**. 2. Click **New agent session**. -3. Name the branch something like `token-to-credit-renaming`. +3. Name the branch something like `docs-refresh-review`. 4. Choose **Codex** as the coding agent for this session. 5. Click **Start** to create a new worktree and agent session. -6. Confirm that: - - A new worktree appears in the left panel. - - The branch is checked out in the new worktree. - - The agent session is ready for instructions. +6. Confirm that a new worktree appears in the left panel, the branch is checked out in that worktree, and the agent session is ready for instructions. -## Ask the agent to update Gemini references +## Ask the agent to review the repository -You can describe the task to the agent in plain language. In this example, start with the Gemini naming update. +Start by asking the agent to inspect the repository and explain which markdown files are most likely to need attention. This gives you a quick understanding of the repo before you make changes. ```text -Search all .md files in this repo for mentions of -"Google Gemini Flash" or "Google Gemini 2.x Flash" -and rename them to "Google Gemini models". +Scan this repository and summarize its structure, key directories, +and the markdown files that look most relevant for setup, +contributor guidance, or other documentation maintenance. +Do not make changes yet. ``` -The agent scans markdown files in the repository and proposes or applies edits, depending on your configuration. Before you let the agent run, validate the target phrasing so you are sure that `Google Gemini Flash` should become `Google Gemini models`. +The agent can scan the repository, identify important docs, and point out where documentation may no longer match the current codebase. This is a useful first step if you are new to the repository or if you want the agent to propose a focused documentation plan. -## Ask the agent to update token references +## Ask the agent to find outdated documentation -Next, update billing and usage wording more carefully. In this case, you only want to rename `tokens` where the text clearly refers to GitKraken AI usage or billing. +Once you know where the docs live, ask the agent to compare those markdown files with the current repository structure, scripts, commands, and conventions. ```text -Search all .md files in this repo for mentions of "tokens" -and change them to "credits" only in the context of -GitKraken AI usage or billing. Do not change unrelated uses -of the word "token". +Compare the README and other markdown documentation to the current +scripts, commands, and file structure in this repository. +Identify anything that looks outdated, inconsistent, or unclear. ``` -The agent may touch multiple pages, including release notes and common issues pages. Review those edits closely because `token` can also appear in unrelated technical contexts. +The agent may identify outdated setup steps, stale file paths, old script names, or contributor instructions that no longer reflect how the repository works today. Review the agent's findings before you ask it to edit files. + +## Ask the agent to update markdown files + +After you confirm the proposed changes, ask the agent to update the affected markdown files. Keep the scope focused on documentation so the review stays simple. + +```text +Update the affected markdown files so the documentation matches the +current repository structure, commands, and conventions. +Keep edits focused and do not change source code. +``` + +The agent can update setup instructions, file references, command examples, or contributor guidance. If your team prefers, you can also ask the agent to show a proposed edit plan before it writes changes. ## Update date stamps for modified pages -Some GitKraken Help Center pages include a `Last updated` date near the top of the page. You can use the agent to keep those dates consistent for any files it changed. +Some repositories include a `Last updated` line near the top of a markdown file. If your documentation uses that pattern, you can ask the agent to update those dates consistently for any files it changed. ```text -For any pages you modified that include a date stamp -at the top, update the date to "April 2026". +For any documentation files you modified that include a "Last updated" +line near the top, update the date to "April 2026". ``` -The agent updates the date line for each affected file. You can verify those changes in the diff view before you commit anything. +The agent updates the date line only where that pattern already exists. You can verify those changes in the diff view before you commit anything. ## Review agent changes in WIP @@ -79,10 +88,9 @@ Agent Sessions View surfaces uncommitted edits for the current worktree in a **W 1. In **Agent Sessions View**, select the current session. 2. Click the **WIP** node at the top of the graph. 3. Use the right-side file list to open each modified markdown file. -4. Confirm that: - - `Google Gemini Flash` references are now `Google Gemini models`. - - `tokens` to `credits` changes only appear in GitKraken AI contexts. - - Date stamps at the top of modified pages are set to `April 2026`. +4. Confirm that the documentation now matches the current repository structure, commands, or conventions. +5. Confirm that the agent only changed markdown files you intended to update. +6. Confirm that date stamps at the top of modified pages are set to `April 2026` if your repo uses that pattern. ## Stage changes and generate commits with GitKraken AI @@ -93,7 +101,7 @@ Once the edits look correct, stage the documentation changes and use GitKraken A 3. Click **Compose commits with AI** to have GitKraken AI group the changes into multiple topic-based commits. 4. Review the suggested commits and optionally squash, drop, or reword them before confirming. -Multiple topic-based commits can help reviewers. For example, you might keep Gemini wording updates separate from `tokens` to `credits` updates and separate both from date-only edits. +Multiple topic-based commits can help reviewers. For example, you might separate README setup fixes from contributor guide updates and keep date-only edits in their own commit. ## Open a pull request from GitKraken Desktop @@ -116,8 +124,8 @@ If you have permission, you can merge the pull request directly from GitKraken D 1. Merge the pull request after review and approval. 2. Pull the latest changes into your local `main`. -3. Confirm that `Google Gemini models` and `AI credits` appear correctly in the updated documentation. -4. If your Help Center publishing flow requires a CMS publish step, complete that process so the changes appear live. +3. Confirm that the updated documentation now reflects the current repository structure and commands. +4. If your documentation is published through a separate site or CMS, complete that publishing step so the changes appear live. ## Clean up the agent worktree From 9abb8378366e2631da716511bd83bdd225d5b0ab Mon Sep 17 00:00:00 2001 From: Jonathan Silva Date: Fri, 24 Apr 2026 14:05:21 -0400 Subject: [PATCH 4/6] docs: Revise example prompts and workflow summary for broad applicability --- ...center-content-with-agent-sessions-view.md | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md index 78eeac4..942a864 100644 --- a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md +++ b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md @@ -141,25 +141,24 @@ Agent Sessions View and List view both point to the same worktrees. When the wor ## Example prompts you can reuse -Use prompts like these when you want to understand a repository before making changes, or when you want to apply the same workflow to a different set of documentation files. +Use prompts like these when you want to understand a repository before making changes, or when you want to apply the same workflow to a different set of markdown documentation files. ```text Scan this repository and tell me which markdown files are most relevant -to terminology updates or documentation maintenance. Summarize what you -find before making any changes. +to setup instructions, contributor guidance, or documentation +maintenance. Summarize what you find before making any changes. ``` ```text -Search markdown files for references to "Google Gemini Flash" or -"Google Gemini 2.x Flash". Show me which files would need to change -to use "Google Gemini models", then make the edits after I confirm. +Compare the README and other markdown documentation to the current +scripts, commands, and file structure in this repository. +Identify anything that looks outdated or inconsistent. ``` ```text -Search markdown files for references to "tokens" and identify which -uses appear to describe product billing, usage, or entitlements. -Change only those references to "credits" and leave unrelated uses -of "token" unchanged. +Update the affected markdown files so the documentation matches the +current repository structure and commands. Keep edits focused and +do not change source code. ``` ```text @@ -173,4 +172,4 @@ Summarize the changes you made, group them into logical commit topics, and suggest commit messages I can use for a pull request. ``` -Reuse this workflow whenever you need to safely review, refactor, or standardize wording across multiple documentation pages with coding agents in GitKraken Desktop. Agent Sessions View helps you keep the worktree, edits, review flow, and pull request connected so the process stays repeatable. +Reuse this workflow whenever you need to safely review, update, or standardize documentation across a repository with coding agents in GitKraken Desktop. Agent Sessions View helps you keep the worktree, edits, review flow, and pull request connected so the process stays repeatable. From a1996c989624c14b2f548be9b7e7f424f536bcc6 Mon Sep 17 00:00:00 2001 From: Jonathan Silva Date: Fri, 24 Apr 2026 14:08:54 -0400 Subject: [PATCH 5/6] =?UTF-8?q?This=20is=20from=20me.=20These=20?= =?UTF-8?q?=F0=9F=91=87=20were=20all=20Codex?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../update-help-center-content-with-agent-sessions-view.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md index 942a864..08b393e 100644 --- a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md +++ b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md @@ -1,6 +1,6 @@ # Update Help Center content with Agent Sessions View -Last updated: April 2026 +Last updated: May 2026 Use this example to review and update repository documentation with a coding agent in GitKraken Desktop. Agent Sessions View is useful for documentation maintenance because it keeps the worktree, agent session, WIP changes, and pull request status together in one place. From 1e432fd44697839c9c0a528031396f9ad6df19e4 Mon Sep 17 00:00:00 2001 From: Jonathan Silva Date: Fri, 24 Apr 2026 14:14:57 -0400 Subject: [PATCH 6/6] docs: Remove date stamp management from Agent Sessions View guide Simplifies the workflow example by removing instructions for managing "Last updated" date stamps. Also refines the introductory text to focus on learning the Agent Sessions View interface. --- ...center-content-with-agent-sessions-view.md | 23 +++---------------- 1 file changed, 3 insertions(+), 20 deletions(-) diff --git a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md index 08b393e..f36c4c1 100644 --- a/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md +++ b/gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md @@ -1,8 +1,8 @@ # Update Help Center content with Agent Sessions View -Last updated: May 2026 +Last updated: April 2026 -Use this example to review and update repository documentation with a coding agent in GitKraken Desktop. Agent Sessions View is useful for documentation maintenance because it keeps the worktree, agent session, WIP changes, and pull request status together in one place. +Use this example to learn how to use Agent Sessions View in GitKraken Desktop with a coding agent. In this workflow, you use a documentation update task to see how Agent Sessions View keeps the worktree, agent session, WIP changes, and pull request status together in one place. ## Before you start @@ -70,17 +70,6 @@ Keep edits focused and do not change source code. The agent can update setup instructions, file references, command examples, or contributor guidance. If your team prefers, you can also ask the agent to show a proposed edit plan before it writes changes. -## Update date stamps for modified pages - -Some repositories include a `Last updated` line near the top of a markdown file. If your documentation uses that pattern, you can ask the agent to update those dates consistently for any files it changed. - -```text -For any documentation files you modified that include a "Last updated" -line near the top, update the date to "April 2026". -``` - -The agent updates the date line only where that pattern already exists. You can verify those changes in the diff view before you commit anything. - ## Review agent changes in WIP Agent Sessions View surfaces uncommitted edits for the current worktree in a **Work in progress (WIP)** node at the top of the graph. This makes it easy to review the full set of documentation changes produced by you or the agent. @@ -90,7 +79,6 @@ Agent Sessions View surfaces uncommitted edits for the current worktree in a **W 3. Use the right-side file list to open each modified markdown file. 4. Confirm that the documentation now matches the current repository structure, commands, or conventions. 5. Confirm that the agent only changed markdown files you intended to update. -6. Confirm that date stamps at the top of modified pages are set to `April 2026` if your repo uses that pattern. ## Stage changes and generate commits with GitKraken AI @@ -102,6 +90,7 @@ Once the edits look correct, stage the documentation changes and use GitKraken A 4. Review the suggested commits and optionally squash, drop, or reword them before confirming. Multiple topic-based commits can help reviewers. For example, you might separate README setup fixes from contributor guide updates and keep date-only edits in their own commit. +Multiple topic-based commits can help reviewers. For example, you might separate README setup fixes from contributor guide updates so each commit stays easy to review. ## Open a pull request from GitKraken Desktop @@ -161,12 +150,6 @@ current repository structure and commands. Keep edits focused and do not change source code. ``` -```text -For any documentation files you modified, check whether they include a -"Last updated" line near the top. Update that date consistently and -show me the affected files in the diff. -``` - ```text Summarize the changes you made, group them into logical commit topics, and suggest commit messages I can use for a pull request.