From 025222da2a39e3a4f962f7f0b4d53fde2d822e89 Mon Sep 17 00:00:00 2001 From: ray Date: Mon, 5 Jan 2026 20:27:01 +0000 Subject: [PATCH] Update documentation references for keymaps and logs - Changed references from KEYMAPS.md to README.md in multiple files. - Updated decision log entries to reflect the new documentation structure. --- .github/copilot-instructions.md | 8 ++++---- AGENTS.md | 6 +++--- LOG.md | 2 +- MIGRATION_PLAN.md | 4 ++-- KEYMAPS.md => README.md | 0 REGRESSION_FIX_2025-12-07.md | 2 +- lua/keymaps_reference.lua | 8 ++++---- 7 files changed, 15 insertions(+), 15 deletions(-) rename KEYMAPS.md => README.md (100%) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 2995284..6e815c0 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -22,7 +22,7 @@ Modern Lua-first Neovim configuration using lazy.nvim, currently in active migra │ └── mason*.lua # LSP server installation ├── AGENTS.md # PRIMARY: All rules, migration plan, do-not-reintroduce list ├── MIGRATION_PLAN.md # Phase-by-phase checklist (source of truth for progress) -├── README.md # Decision log and design rationale +├── LOG.md # Decision log and design rationale └── legacy/ # Archived Vimscript (do not edit; reference only) ``` @@ -111,8 +111,8 @@ return { 1. Check `MIGRATION_PLAN.md` for current phase and priorities 2. **Before large changes**: Update plan via CLI `update_plan` tool (if available) 3. **After any change**: Immediately update `MIGRATION_PLAN.md` (check off items, add notes) -4. **After decisions**: Update `README.md` decisions log -5. **After adding/removing/editing any keymaps**: Immediately update `KEYMAPS.md` with the change (add new entries, remove deleted mappings, or update descriptions) +4. **After decisions**: Update `LOG.md` decisions log +5. **After adding/removing/editing any keymaps**: Immediately update `README.md` with the change (add new entries, remove deleted mappings, or update descriptions) 6. Execute phases via subphases (N.x); one bullet = one implement-and-test step 7. Archive legacy files to `legacy/` instead of deleting @@ -179,5 +179,5 @@ Was caused by settings loading at wrong time; fixed by using `on_new_config` wit ## When Stuck 1. Check `MIGRATION_PLAN.md` for known issues and current phase 2. Review `AGENTS.md` for rules about what to avoid -3. Read `README.md` decisions log for context on past choices +3. Read `LOG.md` decisions log for context on past choices 4. Validate with test workspaces before modifying production config diff --git a/AGENTS.md b/AGENTS.md index a85e420..7b8fa1d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -162,10 +162,10 @@ This repository is being migrated to a modern, minimal Neovim setup driven by Lu - Before large changes, update the task plan via the CLI `update_plan` tool. - Keep the live checklist in `MIGRATION_PLAN.md:1` up to date and in sync with changes. - After any config or plugin change, immediately update `MIGRATION_PLAN.md` (check off items, add notes, or adjust next steps). -- After any change or decision, also update `README.md:1` (decisions log and design docs). -- **After adding/removing/editing any keymaps**, immediately update `KEYMAPS.md` with the change (add new entries, remove deleted mappings, or update descriptions). +- After any change or decision, also update `LOG.md:1` (decisions log and design docs). +- **After adding/removing/editing any keymaps**, immediately update `README.md` with the change (add new entries, remove deleted mappings, or update descriptions). - At the start of each phase, confirm scope and priorities for that phase. - Execute phases via subphases (`N.x`), where each bullet under a phase is its own implement-and-test step (e.g., Phase 3.1, 3.2, 3.3, 3.4). -- Record decisions and rationale in `README.md:1` as they're made. +- Record decisions and rationale in `LOG.md:1` as they're made. - Keep PR-sized patches; avoid broad unrelated edits. - Document non-obvious choices in commit messages or short comments near the code that needs it. diff --git a/LOG.md b/LOG.md index 2a8ac3c..f274dac 100644 --- a/LOG.md +++ b/LOG.md @@ -161,7 +161,7 @@ Record every decision here with a short rationale. Append new entries; do not re - **Validation**: Full config reload tested - all highlight groups load correctly - **Colorscheme integration**: Native Neovim colorscheme at `colors/paper-tonic-modern.lua` - **No overrides needed**: Modern implementation doesn't require separate override file -- 2025-12-12: Added `KEYMAPS.md` + `:KeymapsGuide` floating viewer to document every configured keymap (global + plugin-specific) grouped by source file. +- 2025-12-12: Added keymap reference documentation (now `README.md`) + `:KeymapsGuide` floating viewer to document every configured keymap (global + plugin-specific) grouped by source file. - 2025-12-12: nvim-cmp updated to disable auto-selection; confirm requires explicit item selection. ## Project-Local Configuration (design) diff --git a/MIGRATION_PLAN.md b/MIGRATION_PLAN.md index 17feb7a..665be63 100644 --- a/MIGRATION_PLAN.md +++ b/MIGRATION_PLAN.md @@ -481,8 +481,8 @@ Source of truth for the step-by-step rebuild. Keep this concise and up to date. - [ ] Verify linting (eslint_d, phpcs, markdownlint) ## Phase 12.6 — Final polish -- [x] Review all keymaps and ensure they're documented (KEYMAPS.md + :KeymapsGuide) -- [ ] Update README.md with final architecture and usage +- [x] Review all keymaps and ensure they're documented (README.md + :KeymapsGuide) +- [ ] Update LOG.md with final architecture and usage - [ ] Clean up any remaining debug code or temporary comments --- diff --git a/KEYMAPS.md b/README.md similarity index 100% rename from KEYMAPS.md rename to README.md diff --git a/REGRESSION_FIX_2025-12-07.md b/REGRESSION_FIX_2025-12-07.md index 9a922f2..cb5e90c 100644 --- a/REGRESSION_FIX_2025-12-07.md +++ b/REGRESSION_FIX_2025-12-07.md @@ -109,7 +109,7 @@ vim.api.nvim_create_autocmd('LspAttach', { ``` ## Documentation Updated -- `README.md`: Added decision log entry for 2025-12-07 +- `LOG.md`: Added decision log entry for 2025-12-07 - `.github/copilot-instructions.md`: Documents LspAttach pattern - `AGENTS.md`: Already notes "Native exrc + vim.lsp.config migration done" diff --git a/lua/keymaps_reference.lua b/lua/keymaps_reference.lua index 7255c4a..4e87181 100644 --- a/lua/keymaps_reference.lua +++ b/lua/keymaps_reference.lua @@ -1,6 +1,6 @@ local M = {} -local reference_filename = "KEYMAPS.md" +local reference_filename = "README.md" local reference_path = vim.fn.stdpath("config") .. "/" .. reference_filename local function read_reference() @@ -9,7 +9,7 @@ local function read_reference() if not fd then return { ("Keymap reference file not found: %s"):format(reference_path), - "Create KEYMAPS.md to document mappings.", + "Create README.md to document mappings.", } end @@ -19,7 +19,7 @@ local function read_reference() fd:close() if #lines == 0 then - lines = { "KEYMAPS.md is empty." } + lines = { "README.md is empty." } end return lines @@ -69,6 +69,6 @@ end vim.api.nvim_create_user_command("KeymapsGuide", function() M.open_reference() -end, { desc = "Show KEYMAPS.md in a floating window" }) +end, { desc = "Show README.md keymap reference in a floating window" }) return M