Skip to content

Docs: Fix the onboarding process for Code Suggestions

This issue is to discuss ideas for helping new users with the onboarding process for Code Suggestions.

(For details/research, see the document in this comment. A customer created their own content to try to answer some of these questions.)

The docs should answer these questions about how to access Code Suggestions:

  • If I'm a new user, how do I enable Code Suggestions? (Is it automatically enabled? Which languages is it enabled for? What is the process for each IDE? Is it available in the UI?)
  • Does the process for enabling Code Suggestions differ based on the IDE?
  • If I want to stop viewing Code Suggestions, how do I turn it off?
  • Can I turn on/off code generation and code completion separately?

The docs should also answer these questions about Code Suggestions:

  • What's the difference between code completion and code generation?
  • How do I use Code Suggestions in the different IDEs?
  • Are the same languages supported in different IDEs?

Proposal

Update the current Code Suggestions docs to answer these questions.

The docs are split between Code Suggestions and the editor extensions. Despite this split, we need to give new users a clear path to get started. In my opinion, it should be the Code Suggestions docs (with links from the editor extensions docs).

Note: The difference between completion and generation are listed in this doc: https://docs.gitlab.com/ee/user/gitlab_duo/quick_start.html I think we should remove this page after we improve the onboarding experience in the docs themselves.

Edited by Suzanne Selhorn