Skip to content

Docs: GitLab Duo docs improvements

I want to capture some potential AI doc improvements that I will try to make over time.

To do

  • Take a look at this spreadsheet. These are doc questions people have asked. Just see if you see anything interesting...

    • Jon: There are some signposts to incorrect documentation in the HELP questions that are supported sheet that we should create issues for, validate, and update.
      • Row 14: Indicates that the documentation is missing information.
      • Row 24: Documentation the answer linked to was wrong.
      • Row 44: Suggests that refactoring this documentation would be beneficial.
      • Row 49: Suggests that the summaries of self-managed and .com are out of date.
      • Row 55: Suggests adding an ordered list to how to change merge request approval settings.
      • Row 218: Indicates a change needed to the pipeline APIs page so that Duo picks it instead of the general pipelines page.

  • Maybe weekly, we should check the features listed in the maturity issue and see what the docs look like. We want to make sure the top-level page still matches the docs themselves. (Make sure if they've changed a feature to Beta or GA that the top-level page is updated.)

  • We should look at the heuristic evaluations and keep up with reviews as we are able. We might be able to update docs to help alleviate some of the concerns.

    • Fiona: There are some indications that more info in the docs could help guide users (list is WIP):
      • Activate Duo Pro, Row 13: Subscription docs could state that Duo Pro needs to be turn on post purchase in the settings area.
      • Suggested reviewers, Row 15: Review and validate recommendation. How else can we help improve the docs?

  • Just jotting down an idea/question/food for thought. The extensions have Duo Chat and so does the GitLab UI... But it's not necessarily clear how they work the same/differently... (I think they should work the same, but they don't...) The extensions are hidden away in another area of the docs... What's the best way for a new person to get started? Do we write a getting started guide?

  • Jon: Remove the Suggested Reviewers data usage page, if possible, because portions of it are a duplicate of our central data usage page: https://docs.gitlab.com/ee/user/project/merge_requests/reviews/data_usage.html - See this MR for comments/start: !153727 (closed) See also slack: https://gitlab.slack.com/archives/C05GK6M7FBQ/p1716926631692249?thread_ts=1716391290.847879&cid=C05GK6M7FBQ

  • Suzanne: Consider changing the main AI page to be more focused on what things are, instead of the feature names, which don't always make sense.

  • Suzanne: GDK docs. Try to add some context to the existing steps. Try to do SaaS setup. Started MR here: !156065 (closed) Need to repeat steps from scratch when I have time.

  • Stretch goal, not sure it would even be possible, but what are all the AI feature flags? Right now there are a ton and it's fairly confusing...

AI feature maturity details here: https://gitlab.com/gitlab-org/gitlab/-/issues/444274

For later

Done

Edited by Fiona Neill