Skip to content

Neovim: Stub out Vim auto-command section

Amy Qualls requested to merge aqualls-neovim-auto-commands into master

What does this MR do?

In the first couple of merge requests to copy the Neovim user docs into the gitlab repo, I did not bring over this information because I wasn't sure what to do with it. I'm working on cleaning out the README, and now this info must move:

For your convenience, this plugin provides Vim auto-commands to start the
LSP integration for some supported file types. For example, Ruby is a supported
language, so the plugin adds a `FileType ruby` auto-command.

You can configure this behavior for additional file types with the
`code_suggestions.auto_filetypes` setup option.

This MR is to seek an explanation from an engineer about what this is, what it does, and how to configure the setup option.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Amy Qualls

Merge request reports

Loading