Commit Graph

41 Commits

Author SHA1 Message Date
Justin M. Keyes
16008a64f6
ci: check for deprecated util functions #3462 2024-11-26 07:34:16 -08:00
Justin M. Keyes
9624fffcfa feat(docs): autogenerate default_config docs
Problem:
Docs are manually maintained everywhere for no good reason.

Solution:
- revert commit 9dc02492c4
- provide a "gF" friendly link to the source
2024-10-24 17:24:45 +02:00
glepnir
7be9986a4a
docs: add requirement of a new server (#3368)
* docs: add requirement of a new server


Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
2024-10-15 18:05:26 +08:00
Justin M. Keyes
dcf511d53f
ci: rename README_template.md #3357
The name `README_template.md` is confusing, because it is not related to
the README (that changed long ago).
2024-10-06 03:47:24 -07:00
Justin M. Keyes
bedb2a0df1
refactor: rename "server_configurations" => "configs" #3330
Problem:
The name `server_configurations` is extremely verbose and irritatingly
formal and dogmatic. This overlong name is a constant nuisance when
reading, writing, and coding.

It's also not even correct: these configurations are just as much
"client" configurations as they are "server" configurations.

Solution:
- Rename to a shorter name.
- Leave placeholder files for any old URLs that link to the old
  location.
2024-10-01 05:39:12 -07:00
Justin M. Keyes
36f21ab955 docs: CONTRIBUTING.md cleanup 2024-10-01 14:10:27 +02:00
Antonin Godard
bd7c76375a
fix(CONTRIBUTING): typos (#3204)
Fix tense and incomplete sentence.

Signed-off-by: Antonin Godard <antoningodard@pm.me>
2024-06-15 11:22:52 +08:00
dundargoc
aa5f4f4ee1
docs: simplify CONTRIBUTING documentation #3132
- Deduplicate lint requirements.
- remove minimum neovim version as that is already specified by the
  README.
2024-04-29 08:59:07 -07:00
strager
570aae82f8
docs: fix broken links to LSP specification (#2631) 2023-05-24 08:46:01 +08:00
Raphael
4a69ad6646
fix: use exepath on server command (#2595) 2023-05-09 15:10:14 +08:00
Zhizhen He
c6105c4496
chore: remove redundant config for Lua (#2523) 2023-03-23 16:35:08 +08:00
Justin M. Keyes
4f94bf5ba9 docs: unverbose, mention "settings" param
Problem:
- The docs are verbose.
- The "settings" param is not really clarified anywhere.

Solution:
- Mention the "settings" param in the README.
- Tighten up the wording.
- Remove the "Use a loop to conveniently call 'setup'..." advice in the
  docs. It confuses users and doesn't really save much code.
- Start to reduce the scope of nvim-lspconfig.
  - For example, it is redundant for it to document general LSP things.
    Thus, the help section *lspconfig-lsp* was removed.

closes #1951
2022-06-13 01:44:59 -07:00
Michael Lingelbach
31be570201
docs: update outdated example in contributing (#1843) 2022-04-16 22:45:14 -07:00
Michael Lingelbach
700eda9131
chore: remove all package.json (#1656) 2022-02-25 09:02:19 -08:00
Michael Lingelbach
0d2fb782ca
docs: update CONTRIBUTING.md 2021-12-26 16:22:34 -05:00
kylo252
eee8240ec6 chore(docs): add a section about windows shims 2021-12-08 09:18:54 +01:00
dundargoc
4cc2a087e2
docs: add selene to the list of required linters (#1536)
Also add a link to each linters repository.
2021-12-04 05:55:15 -08:00
Michael Lingelbach
97da7ed12e chore: clean up imports 2021-11-25 23:46:21 -05:00
Michael Lingelbach
17008c63ec
docs: clarify server naming conventions (#1456) 2021-11-19 20:11:15 -05:00
Michael Lingelbach
9de4ceb931
docs: make CONTRIBUTING more visible via move (#1396) 2021-11-10 08:48:15 -08:00
Michael Lingelbach
3d85ff447d
docs: documentation overhaul (#1384)
* remove automated generation of vimdoc + ci
* unify ADVANCED_README.md and vimdoc
* rename CONFIGS.md to server_configurations.md, move into doc folder
* move CONTRIBUTING.md to .github folder
2021-11-09 09:53:21 -08:00
Michael Lingelbach
ba90dc2930 docs: update contributing guide 2021-10-30 13:38:56 -07:00
Michael Lingelbach
5e89fcbb8b
Update CONTRIBUTING.md 2021-07-04 20:09:00 -07:00
Michael Lingelbach
5add2effdf Update 2021-05-17 08:40:29 -07:00
Michael Lingelbach
93c3431158 Remove all installers and install logic 2021-01-03 06:53:43 -08:00
Hirokazu Hata
ddcd9e6aae
Rename nvim_lsp to lspconfig 2020-09-06 17:49:21 +09:00
Justin M. Keyes
53f0c2d054
doc #346 2020-09-05 16:22:27 -07:00
Hirokazu Hata
1ab0fdbf6e
Makefile: add lint commant 2020-05-21 17:14:39 +09:00
Justin M. Keyes
8734a26c3c docgen.lua: require() all configs
Since 6d38067750, configs are lazy-loaded. So docgen.lua needs to
require() them explicitly.
2020-02-02 19:13:42 -08:00
Hirokazu Hata
6d38067750
nvim_lsp.lua: lazy require language server modules (#109) 2020-02-02 18:31:45 +09:00
Justin M. Keyes
4107425f5c
doc #108
- mention :packadd
- more renames
2020-01-31 02:20:41 -08:00
Michael Lingelbach
b487481e19
rename "skeleton" to "configs" #100
`nvim_lsp/skeleton.lua` is not really a skeleton, it's a `configs`
class that provides

1. actual functionality
2. a bunch of configs

Each config is added to the `configs` object (FKA "skeleton") as
a property. Those configs are not "templates", they are "configs". So we
should clean up the wording in various places to say "config" instead of
"skeleton"/"template".

Closes #64
2020-01-31 00:00:50 -08:00
Hirokazu Hata
10d3a9bde1 CI: luacheck #86 2019-12-31 14:15:50 -08:00
Justin M. Keyes
56192022b2 remove Vimscript wrapper nvim_lsp#setup()
Lua is easy to use from Vimscript, there is no reason to have multiple
ways to work with nvim-lsp.

- massively clarifies the "story" that users need to comprehend
- reduces surface area, maintenance, tests
- avoids constant "Vim or Lua" dance in the documentation
- simplifies discussions, tutorials, etc.
- avoids confusing situation for users that start with Vimscript but
  later need Lua-only features
2019-12-08 03:04:13 -08:00
Ashkan Kiani
ac3df47ffd
Use a template for README.md (#28) 2019-11-17 09:58:52 -08:00
Ashkan Kiani
5686a90890
Redo installation. (#17)
* Redo installation.

Servers which want to be auto installed should specify
skeleton[name].install()
and it will be automatically added to the list of installable servers.

- Add :LspInstall and :LspInstallInfo
- Auto generate docs for servers with .install() available.
- Add util.npm_installer
- Refactor utf8 capabilities common config into a single function
- Add contribution notes.
- Also expose util.base_install_dir for other installers potentially
- Fix tsserver's arguments and add javascript filetypes
2019-11-15 17:26:22 -08:00
Ashkan Kiani
ec406e17fd
Add github actions for docgen (#7)
* Create main.yml
* Update CONTRIBUTING and REAMDE.
Explain that Github Actions generate README.
2019-11-14 15:20:31 -08:00
Ashkan Kiani
13c8ca22ca Improve documentation and docgen command.
Also improve the recommended command for running docgen.
2019-11-14 11:01:16 -08:00
Ashkan Kiani
9666b63a70 Rename to nvim_lsp and nvim-lsp. 2019-11-14 01:07:09 -08:00
Ashkan Kiani
5e06768e10 Darn you, tabs. 2019-11-14 00:51:30 -08:00
Ashkan Kiani
8bb6448e79 Add contributing docs and clangd config. 2019-11-14 00:50:01 -08:00