Skip to content

Code suggestions: sidebar multiple suggestions (post-MVC)

Background

We will be launching AI assisted code suggestions as a pre-installed extension in the GitLab web IDE in May. This issue is part of an epic for the UX portion of this project.

What's this issue all about

Code suggestions has the ability to show multiple suggestions. This issue proposes showing multiple suggestions in the sidebar.

CleanShot_2023-03-22_at_15.07.15

The sidebar has 3 sections:

Logic

  • Suggestions sidebar updates as the user moves the cursor through the editor
  • Suggestions sidebar can communicate various statuses:
    • No suggestions at the moment
    • Code suggestions does not work on [programming language]
    • Code suggestions is down
    • Code suggestions is disabled at the moment
    • Code suggestions needs to be enabled by your GitLab group admin
    • Loading suggestions

Designs

  • Design impression in design management below
  • Figma file - under Sidebar states section

Things to note

Image Description Question
Screenshot_2023-03-22_at_15.13.19 Suggestions load sequentially Is this how it works technically?
Screenshot_2023-03-22_at_15.11.13 As more suggestions load, the counter next to the title SUGGESTIONS increases Is this possible?
Screenshot_2023-03-22_at_15.14.26 Suggestions have syntax highlighting
Screenshot_2023-03-22_at_15.15.02 Suggestions do not wrap. The user can scroll horizontally. Suggestions have a max height. The user can scroll vertically. What should the max height be?
CleanShot_2023-03-22_at_15.16.24 Suggestions sidebar updates contextually - e.g. if the user accepts a suggestion, the sidebar updates to no suggestions at the moment
Screenshot_2023-03-22_at_15.17.35 It's possible to give feedback on a suggestion (issue) If a user is giving feedback on a specific suggestion, can we pass the suggestion (the code itself) with the user's feedback?
Screenshot_2023-03-22_at_15.20.40 It's possible that the suggestions section of the sidebar can communicate many statuses including things like "no suggestions", "suggestions does not work on [programming language]", "suggestions is down", "suggestions is disabled", "suggestions needs to be enabled by a GitLab group admin", "Loading" What other statuses?
Edited by Katie Macoy (on PTO)