Adds Agent Sessions View documentation guide

gitkraken-desktop/update-help-center-content-with-agent-sessions-view.md

@@ -0,0 +1,158 @@
+# Update Help Center content with Agent Sessions View
+
+<kbd>Last updated: April 2026</kbd>
+
+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
+
+Make sure you have the following:
+
+- GitKraken Desktop installed and updated to a version that includes Agent Sessions View
+- 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
+
+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 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
+
+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 `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 that worktree, and the agent session is ready for instructions.
+
+## Ask the agent to review the repository
+
+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
+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 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 find outdated documentation
+
+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
+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 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.
+
+## 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 the documentation now matches the current repository structure, commands, or conventions.
+5. Confirm that the agent only changed markdown files you intended to update.
+
+## 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 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
+
+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 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
+
+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 markdown documentation files.
+
+```text
+Scan this repository and tell me which markdown files are most relevant
+to setup instructions, contributor guidance, or documentation
+maintenance. Summarize what you find before making any changes.
+```
+
+```text
+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
+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
+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, 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.