Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix: format doc/configs.txt as proper :help-compatible help file #3674

Closed
wants to merge 1 commit into from
Closed

fix: format doc/configs.txt as proper :help-compatible help file #3674

wants to merge 1 commit into from

Conversation

o6ivp
Copy link
Contributor

@o6ivp o6ivp commented Mar 29, 2025 •
edited
Loading

Fixes #3600

This PR reformats doc/configs.txt to follow Neovim :help conventions.

What it does

  • Adds proper *tag* definitions for each server (*pyright*, *gopls*, etc.)
  • Ensures :help lspconfig-all, :help ada_ls etc. work
  • Fixes broken K key and helptags indexing
  • Removes duplicate tags, fixes formatting, adds section headers

Why this is needed

Currently, configs.txt is not valid as a :help file and cannot be indexed properly (see #3600).
This PR does not change content — only formatting.

Note: This change causes an error because the contents of configs.md and configs.txt are different.

@github-actions GitHub Actions
Copy link
Contributor

Note that configs.md or configs.txt will be regenerated by the docgen CI process. Edit the Lua source file instead. For details on generating documentation, see: https://github.com/neovim/nvim-lspconfig/blob/master/CONTRIBUTING.md#generating-docs

@justinmk
Copy link
Member

justinmk commented Mar 29, 2025 •
edited
Loading

doc/configs.txt is autogenerated by https://github.com/neovim/nvim-lspconfig/blob/master/scripts/docgen.lua . You would need to update that generator. If you plan to do that, feel free to reopen this.

@justinmk justinmk closed this Mar 29, 2025
@o6ivp o6ivp mentioned this pull request Mar 29, 2025
Merged
@o6ivp
Copy link
Contributor Author

o6ivp commented Mar 29, 2025

Thanks for the review. I have corrected the issue in #3675.
I would be happy to have your feedback again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glepnir glepnir Awaiting requested review from glepnir glepnir will be requested when the pull request is marked ready for review glepnir is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

:help pages filetype anchors
2 participants
@o6ivp @justinmk