Skip to content

Create a better Explain UX #4244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
14 tasks
d13 opened this issue Apr 22, 2025 · 0 comments
Open
14 tasks

Create a better Explain UX #4244

d13 opened this issue Apr 22, 2025 · 0 comments
Assignees
Labels
area-ai Issues or features related to AI

Comments

@d13
Copy link
Member

d13 commented Apr 22, 2025

The only way to explain commits today is through the "Explain Changes" button in the commit details panel, which limits its exposure to users. It also renders the output in a small window can be difficult to read depending on screen/panel size.

There are two primary goals for this task:

  1. Expose the commit explanation feature in more places
  2. Add more explain options
  3. Open commit explanations in a markdown file where they can be easily read.

Expose the commit explanation feature in more places

  • remove the existing "Explain Changes" button (and view) from commit details
  • add an "Explain" button to the bottom of the commit message element
  • allow users to explain a single commit from the graph via context menu
  • allow users to explain multi-selected commits from the graph via context menu
  • allow users to explain commits via a command in the command palette (similar to changelog generation flow)
  • allow users to explain commits from the commits view
  • allow users to explain commits from Search & Compare

Add more explain options

  • explain a branch (from branch cards, from graph ref, from branches view, etc.)
  • explain a wip

Open explanations in a markdown file

  • remove the Explain (AI) section from the commit details
  • open explanations in a markdown file
    • explore automatically opening the file in the markdown preview for easier reading
    • modify the output with new headers/sections (see image)
    • consider adding a linked sha for a single commit that opens the commit in the graph / commit details
Image
@d13 d13 self-assigned this Apr 22, 2025
@d13 d13 added area-ai Issues or features related to AI needs-exploration Issue that needs design, research, POC, etc. labels Apr 22, 2025
@d13 d13 changed the title Create a better explain UX Create a better Explain UX Apr 22, 2025
@justinrobots justinrobots removed the needs-exploration Issue that needs design, research, POC, etc. label Apr 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-ai Issues or features related to AI
Projects
None yet
Development

No branches or pull requests

2 participants