From bedb2a0df105f68a624a49b867f269b6d55a2c89 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Tue, 1 Oct 2024 05:39:12 -0700 Subject: 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. --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 457b2626..7db8f850 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -126,11 +126,11 @@ If using nix, you can use `nix develop` to install these to a local nix shell. ## Generating docs -GitHub Actions automatically generates `server_configurations.md`. Only modify +GitHub Actions automatically generates `configs.md`. Only modify `scripts/README_template.md` or the `docs` table in the server config Lua file. -Do not modify `server_configurations.md` directly. +Do not modify `configs.md` directly. -To preview the generated `server_configurations.md` locally, run `scripts/docgen.lua` from +To preview the generated `configs.md` locally, run `scripts/docgen.lua` from `nvim` (from the project root): nvim -R -Es +'set rtp+=$PWD' +'luafile scripts/docgen.lua' -- cgit v1.2.3-70-g09d2