Docs #1

Merged

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

Conversation 0 Commits 15 Files Changed 71

+2496 -1914

gffranco commented 2026-05-30 13:10:01 +00:00

Owner

Copy Link

Copy Source

No description provided.

gffranco added 5 commits 2026-05-30 13:10:02 +00:00

Add onboarding documentation and architecture diagram a1a0c44a62

Update help file to clarify nuwiki and vimwiki command forms 753d9e28ea

Update help file to show Nuwiki commands for brevity 7fc5b8e5bf

Update help file to show Nuwiki commands for brevity and change all command listings to Nuwiki form 8bf20b412d

Fix help file: correct vimwiki-compatible form and ensure all commands are in Nuwiki form 93725501dc

gffranco added 1 commit 2026-05-30 16:56:37 +00:00

Fix glp backward cycle and gl<Space> current-list scope ... 21ac9deb23

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>

gffranco added 1 commit 2026-05-30 17:09:15 +00:00

Move dev launcher scripts into scripts/ to declutter root ... 9ec1adb3e7

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>

gffranco added 1 commit 2026-05-30 17:29:28 +00:00

Move developer docs into development/ to declutter root ... dd92e070d0

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>

gffranco added 1 commit 2026-05-30 17:35:30 +00:00

Move development scripts into development/, leaving scripts/ plugin-only ... f32f54e8a8

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>

gffranco added 1 commit 2026-05-30 17:40:43 +00:00

Group keymap harnesses under development/tests/ ... 088cf81bcb

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>

gffranco added 1 commit 2026-05-30 17:51:04 +00:00

Replace test-personal-wiki.sh with a generated sample wiki ... 1753292814

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>

gffranco added 1 commit 2026-05-30 17:59:12 +00:00

Extract shared launcher logic into development/_common.sh ... edab2ec578

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>

gffranco added 1 commit 2026-05-30 18:08:05 +00:00

Move SPEC.md to development/ and rewrite as a technical reference ... 5135840f05

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>

gffranco added 2 commits 2026-05-30 18:28:19 +00:00

Remove stale phase/spec references from code comments ... 21b485c91b

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>

Rename phase-numbered tests and drop SPEC pointer from stub messages ... e5dde2e338

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>

gffranco merged commit 8ab6015405 into main 2026-05-30 18:35:41 +00:00

gffranco deleted branch docs 2026-05-30 18:35:50 +00:00

gffranco referenced this issue from a commit 2026-05-31 10:54:42 +00:00

docs(client): document link-follow commands on both editors + tab-drop

gffranco referenced this issue from a commit 2026-05-31 21:04:35 +00:00

fix(commands): route Neovim *Link Ex-commands through follow_link_or_create

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

No items

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

gffranco (Gabriel Fróes Franco)

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: gffranco/nuwiki#1