Docs #1

Merged
gffranco merged 15 commits from docs into main 2026-05-30 18:35:41 +00:00

15 Commits

Author SHA1 Message Date
gffranco e5dde2e338 Rename phase-numbered tests and drop SPEC pointer from stub messages
CI / cargo fmt --check (push) Successful in 38s
CI / cargo clippy (push) Successful in 19s
CI / cargo test (push) Successful in 48s
CI / cargo fmt --check (pull_request) Successful in 41s
CI / cargo clippy (pull_request) Successful in 26s
CI / cargo test (pull_request) Successful in 35s
CI / editor keymaps (push) Successful in 1m23s
CI / editor keymaps (pull_request) Successful in 1m26s
Rename the four commands_list_includes_phaseNN_entries tests after the
command namespace they cover (wiki, link health, export, diary), and
strip the "see SPEC §13.1" pointer from the not-yet-implemented runtime
notifications.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 15:28:06 -03:00
gffranco 21b485c91b Remove stale phase/spec references from code comments
Strip "Phase N", "SPEC §X.Y", and "v1.x" planning labels from comments
across the Rust crates and editor layers now that those tracking
artifacts are gone. Comments only — no logic, strings, or test names
touched.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 15:25:51 -03:00
gffranco 5135840f05 Move SPEC.md to development/ and rewrite as a technical reference
CI / cargo fmt --check (push) Successful in 19s
CI / cargo clippy (push) Successful in 24s
CI / cargo test (push) Successful in 28s
CI / cargo fmt --check (pull_request) Successful in 17s
CI / cargo clippy (pull_request) Successful in 36s
CI / cargo test (pull_request) Successful in 35s
CI / editor keymaps (push) Successful in 1m23s
CI / editor keymaps (pull_request) Successful in 1m35s
The old spec was a 1426-line forward-looking planning doc (phases,
pending decisions, design sketches for work now shipped). Replace it
with a concise 339-line reference describing the implemented system —
architecture, AST, LSP capabilities + executeCommand surface, editor
integration, config schema, keymaps, syntax support, and CI — verified
against the current code. Lives under development/ with the other
developer-only docs.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 15:07:59 -03:00
gffranco edab2ec578 Extract shared launcher logic into development/_common.sh
CI / cargo fmt --check (push) Successful in 27s
CI / cargo clippy (push) Successful in 28s
CI / cargo test (push) Successful in 31s
CI / cargo fmt --check (pull_request) Successful in 16s
CI / cargo clippy (pull_request) Successful in 29s
CI / cargo test (pull_request) Successful in 46s
CI / editor keymaps (push) Successful in 1m38s
CI / editor keymaps (pull_request) Successful in 1m40s
start-nvim.sh and start-vim.sh now source a common helper for the
paths, log(), ensure_binary(), and the sample-wiki fixture, so the
fixture lives in exactly one place instead of being duplicated across
both launchers. Each launcher keeps only its editor-specific config
generation. start-nvim.sh also gains the NUWIKI_DEV_NO_SEED guard for
parity with start-vim.sh.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 14:59:06 -03:00
gffranco 1753292814 Replace test-personal-wiki.sh with a generated sample wiki
CI / cargo fmt --check (push) Successful in 25s
CI / cargo clippy (push) Successful in 22s
CI / cargo test (push) Successful in 35s
CI / cargo fmt --check (pull_request) Successful in 20s
CI / cargo clippy (pull_request) Successful in 22s
CI / cargo test (pull_request) Successful in 26s
CI / editor keymaps (push) Successful in 1m36s
CI / editor keymaps (pull_request) Successful in 1m23s
Drop the personal-wiki launcher in favor of a self-contained fixture
the dev launchers seed into the cache. write_sample_wiki() lays down
one page per vimwiki feature group (syntax, lists, tables, links,
notes, diary) so every plugin feature has something to exercise
without touching a real wiki.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 14:50:58 -03:00
gffranco 088cf81bcb Group keymap harnesses under development/tests/
CI / cargo fmt --check (push) Successful in 27s
CI / cargo clippy (push) Successful in 34s
CI / cargo test (push) Successful in 35s
CI / cargo fmt --check (pull_request) Successful in 32s
CI / cargo clippy (pull_request) Successful in 28s
CI / cargo test (pull_request) Successful in 33s
CI / editor keymaps (push) Successful in 1m27s
CI / editor keymaps (pull_request) Successful in 1m27s
Move the four keymap-harness files (test-keymaps.sh/.lua and the Vim
counterparts) into a development/tests/ subfolder so they sit apart from
the interactive dev launchers. REPO_ROOT now climbs two levels, and the
internal source paths, CI invocations, and ONBOARDING tree are updated.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 14:40:37 -03:00
gffranco f32f54e8a8 Move development scripts into development/, leaving scripts/ plugin-only
CI / cargo fmt --check (push) Successful in 32s
CI / cargo clippy (push) Successful in 25s
CI / cargo test (push) Successful in 33s
CI / cargo fmt --check (pull_request) Successful in 30s
CI / cargo clippy (pull_request) Successful in 49s
CI / cargo test (pull_request) Successful in 43s
CI / editor keymaps (push) Successful in 1m49s
CI / editor keymaps (pull_request) Successful in 1m36s
The root scripts/ folder now holds only download_bin.vim, the one script
the plugin itself invokes (via :NuwikiInstall and the vim-plug/Dein build
hooks). All developer tooling — the start-nvim/start-vim launchers,
test-personal-wiki, the keymap harnesses, and syntax-diag — moves to
development/ alongside the developer docs.

REPO_ROOT resolution is unchanged (development/ sits one level under root,
same as scripts/ did); only the explicit cross-references, the CI harness
invocations, the README launcher paths, and the ONBOARDING structure tree
are updated.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 14:35:24 -03:00
gffranco dd92e070d0 Move developer docs into development/ to declutter root
CI / cargo fmt --check (push) Successful in 24s
CI / cargo clippy (push) Successful in 18s
CI / cargo test (push) Successful in 46s
CI / cargo fmt --check (pull_request) Successful in 24s
CI / cargo clippy (pull_request) Successful in 23s
CI / cargo test (pull_request) Successful in 29s
CI / editor keymaps (push) Successful in 1m25s
CI / editor keymaps (pull_request) Successful in 1m23s
Relocate ONBOARDING.md and nuwiki-architecture.html out of the repo root
into a dedicated development/ folder. No file references either path, so
the move is self-contained.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 14:29:23 -03:00
gffranco 9ec1adb3e7 Move dev launcher scripts into scripts/ to declutter root
CI / cargo fmt --check (push) Successful in 37s
CI / cargo clippy (push) Successful in 35s
CI / cargo test (push) Successful in 32s
CI / cargo fmt --check (pull_request) Successful in 29s
CI / cargo clippy (pull_request) Successful in 46s
CI / cargo test (pull_request) Successful in 52s
CI / editor keymaps (push) Successful in 1m36s
CI / editor keymaps (pull_request) Successful in 1m21s
Relocate start-nvim.sh, start-vim.sh and test-personal-wiki.sh from the
repo root into scripts/, alongside the existing test harnesses. Each
script now derives REPO_ROOT one level up, test-personal-wiki.sh execs
the moved start-vim.sh, and the README + usage comments point at the new
paths.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 14:09:06 -03:00
gffranco 21ac9deb23 Fix glp backward cycle and gl<Space> current-list scope
CI / cargo fmt --check (push) Successful in 16s
CI / cargo clippy (push) Successful in 21s
CI / cargo test (push) Successful in 37s
CI / cargo fmt --check (pull_request) Successful in 34s
CI / cargo clippy (pull_request) Successful in 36s
CI / cargo test (pull_request) Successful in 38s
CI / editor keymaps (push) Successful in 1m23s
CI / editor keymaps (pull_request) Successful in 1m31s
Two documented checkbox-list mappings did not match their spec:

- `glp` dispatched the same forward-only cycleCheckbox as `gln`, so it
  could never "cycle the checkbox state backward". Add `ops::cycle_state_back`
  and thread a `reverse` flag through the dispatcher and both clients.

- `gl<Space>` and `gL<Space>` both swept the whole buffer, making them
  identical. `gl<Space>` now passes the cursor position and the server
  scopes deletion to the contiguous list block under the cursor (current
  list, cascading into sublists); `gL<Space>` stays whole-buffer.

Adds Rust unit tests, plus behavioral and full-registration coverage for
the documented mapping surface in the Neovim and Vim keymap harnesses, and
a command-coverage suite mirroring the doc's command groups.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
2026-05-30 13:56:28 -03:00
gffranco 93725501dc Fix help file: correct vimwiki-compatible form and ensure all commands are in Nuwiki form
CI / cargo fmt --check (push) Successful in 23s
CI / cargo clippy (push) Successful in 23s
CI / cargo test (push) Successful in 42s
CI / editor keymaps (push) Successful in 1m23s
CI / cargo fmt --check (pull_request) Successful in 56s
CI / cargo clippy (pull_request) Successful in 25s
CI / cargo test (pull_request) Successful in 1m13s
CI / editor keymaps (pull_request) Successful in 1m18s
2026-05-30 12:51:01 +00:00
gffranco 8bf20b412d Update help file to show Nuwiki commands for brevity and change all command listings to Nuwiki form
CI / cargo fmt --check (push) Successful in 1m3s
CI / cargo clippy (push) Successful in 49s
CI / cargo test (push) Successful in 46s
CI / editor keymaps (push) Successful in 1m22s
2026-05-30 12:43:47 +00:00
gffranco 7fc5b8e5bf Update help file to show Nuwiki commands for brevity
CI / cargo fmt --check (push) Successful in 18s
CI / cargo clippy (push) Successful in 22s
CI / cargo test (push) Successful in 26s
CI / editor keymaps (push) Successful in 1m11s
2026-05-30 12:02:29 +00:00
gffranco 753d9e28ea Update help file to clarify nuwiki and vimwiki command forms
CI / cargo fmt --check (push) Successful in 17s
CI / cargo clippy (push) Successful in 21s
CI / cargo test (push) Successful in 29s
CI / editor keymaps (push) Successful in 1m21s
2026-05-30 03:35:15 +00:00
gffranco a1a0c44a62 Add onboarding documentation and architecture diagram
CI / cargo fmt --check (push) Successful in 1m5s
CI / cargo clippy (push) Successful in 33s
CI / cargo test (push) Successful in 45s
CI / editor keymaps (push) Successful in 1m21s
2026-05-30 02:43:03 +00:00