diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2024-10-06 03:47:24 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-06 03:47:24 -0700 |
| commit | dcf511d53fae9675c6fde4241d94b2daaa5e0cd5 (patch) | |
| tree | 2d2c940736ca325378f4c905c09ca2317a3dcea6 | |
| parent | docs: update configs.md (diff) | |
| download | nvim-lspconfig-dcf511d53fae9675c6fde4241d94b2daaa5e0cd5.tar nvim-lspconfig-dcf511d53fae9675c6fde4241d94b2daaa5e0cd5.tar.gz nvim-lspconfig-dcf511d53fae9675c6fde4241d94b2daaa5e0cd5.tar.bz2 nvim-lspconfig-dcf511d53fae9675c6fde4241d94b2daaa5e0cd5.tar.lz nvim-lspconfig-dcf511d53fae9675c6fde4241d94b2daaa5e0cd5.tar.xz nvim-lspconfig-dcf511d53fae9675c6fde4241d94b2daaa5e0cd5.tar.zst nvim-lspconfig-dcf511d53fae9675c6fde4241d94b2daaa5e0cd5.zip | |
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).
| -rw-r--r-- | CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | scripts/docgen.lua | 2 | ||||
| -rw-r--r-- | scripts/docs_template.md (renamed from scripts/README_template.md) | 0 |
3 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7db8f850..2b79c9d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -127,7 +127,7 @@ If using nix, you can use `nix develop` to install these to a local nix shell. ## Generating docs GitHub Actions automatically generates `configs.md`. Only modify -`scripts/README_template.md` or the `docs` table in the server config Lua file. +`scripts/docs_template.md` or the `docs` table in the config code. Do not modify `configs.md` directly. To preview the generated `configs.md` locally, run `scripts/docgen.lua` from diff --git a/scripts/docgen.lua b/scripts/docgen.lua index 79beebe0..e81f0aca 100644 --- a/scripts/docgen.lua +++ b/scripts/docgen.lua @@ -278,7 +278,7 @@ local function generate_readme(template_file, params) end require_all_configs() -generate_readme('scripts/README_template.md', { +generate_readme('scripts/docs_template.md', { implemented_servers_list = make_implemented_servers_list(), lsp_server_details = make_lsp_sections(), }) diff --git a/scripts/README_template.md b/scripts/docs_template.md index cb25a45c..cb25a45c 100644 --- a/scripts/README_template.md +++ b/scripts/docs_template.md |