Skip to content

docs(desktop-windows): update AGENTS.md with Node 22 pin, Wayland notes, and parity audit - #12256

Open
formed2forge wants to merge 1 commit into
BasedHardware:mainfrom
formed2forge:docs/windows-agents-md
Open

docs(desktop-windows): update AGENTS.md with Node 22 pin, Wayland notes, and parity audit#12256
formed2forge wants to merge 1 commit into
BasedHardware:mainfrom
formed2forge:docs/windows-agents-md

Conversation

@formed2forge

@formed2forge formed2forge commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Comprehensive update to the Windows/Linux desktop AGENTS.md documentation:

  • Documents the Node 22.19+ pin in AGENTS.md and adds .nvmrc
  • Documents Wayland blank-window and floating-window quirks for Linux devs
  • Re-audits and updates parity-audit files 01-14 against current source
  • Adds parity-audit sequencing/effort plan
  • Strips trailing whitespace in mac-parity-audit files

Test plan

  • Verify .nvmrc pins to Node 22
  • Review AGENTS.md Wayland section for accuracy on a Linux dev machine
  • Check that parity audit file updates reflect current feature state

🤖 Generated with Claude Code

Review in cubic

@Git-on-my-level Git-on-my-level left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this — the re-audit work is thorough and the Node-pin writeup is exactly the kind of environment gotcha worth having in the guide. I verified the new paragraph's claims against package.json (engines.node >=22.19.0 <23), desktop/windows/.nvmrc (22.19.0), desktop-windows-ci.yml (actions/setup-node@v7, node-version: 22, pnpm/action-setup@v6 pinned to 10), and scripts/check-node-version.mjs (the pretest hook) — all accurate.

Two things need fixing before this can merge:

  1. Please rebase onto current main. Your branch is 279 commits behind (merge-base 2026-08-21). Essentially all of this PR — the desktop/windows/AGENTS.md file itself, the root AGENTS.md index row, the lean-check budget entry, .nvmrc, and the full 2026-08-22 parity re-audit including 14-sequencing-plan.md — already landed on main via your own #12034 (merged 2026-08-24). I compared all 21 changed files against main: 20 are byte-identical. After a rebase this PR will contain only the genuinely new content.

  2. The Node-pin paragraph pushes the guide over its size budget. desktop/windows/AGENTS.md would be 136 lines / 7,414 bytes against the ratchet budget of 127 lines / 6,950 bytes in .github/scripts/check_agents_md_lean.py (the agents-md-lean check, run in both the local and ci lanes via .github/checks-manifest.yaml). No Actions run happened on this head, so nothing surfaced it — but it will fail repo-checks on merge to main. The check's own guidance is to move detail down a level rather than grow the file: the Node 24 localStorage/jsdom failure story and --localstorage-file detail would fit naturally in docs/multi-worktree-dev.md (which already carries the env quirks table) or a docs/agents/ note, linked from the guide in one line. Alternatively, condense the paragraph to its core instruction (pin Node 22 via .nvmrc/nvm use; the pretest hook catches mismatches early) — that fits within the current budget.

The paragraph's substance is right; it's purely a placement/size issue per the repo's lean-guide policy. With a rebase plus either the trim or the move, this should be a quick re-review.


by AI on behalf of David — if you need David’s attention urgently, please @Git-on-my-level and escalate with need human response.

@Git-on-my-level Git-on-my-level added docs-accuracy Documentation or committed reports need accuracy fixes windows Windows desktop work labels Aug 26, 2026
package.json's engines field and .nvmrc already constrain Node to
>=22.19.0 <23, and scripts/check-node-version.mjs fires at pretest
to produce a legible error message, but nothing in the AGENTS.md
told a contributor before they hit the check or, worse, saw silent
jsdom localStorage breakage on Node 24+. Add a one-line note
mirroring the existing pnpm major-version pin entry.

.nvmrc (22.19.0) was already merged via BasedHardware#12034.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@formed2forge
formed2forge force-pushed the docs/windows-agents-md branch from 91d84b7 to 2faa66f Compare August 27, 2026 13:32
@formed2forge

Copy link
Copy Markdown
Contributor Author

Rebased onto current upstream/main (was 408 commits behind). Key findings after comparing all 8 original commits against upstream:

Already merged via #12034:

  • .nvmrc (22.19.0) ✓
  • 14-sequencing-plan.md
  • Parity audit re-audit (files 01–13) ✓
  • Wayland blank-window / setBounds quirks in docs/multi-worktree-dev.md
  • Trailing whitespace fix in 10-onboarding.md
  • release-pipeline.md corrected trigger claim (workflow_dispatch only, no push trigger) ✓
  • Wayland section in AGENTS.md

Still genuinely missing (applied in this rebase):

  • The Node 22.19+ pin note in desktop/windows/AGENTS.md — mirrors the existing pnpm major-version-pin entry; explains the >=22.19.0 <23 constraint and why (pretest hook, Node 24+ jsdom localStorage shadowing). Condensed to 1 line to stay within the 127-line / 6,950-byte agents-md-lean budget.

Branch is now 1 commit ahead of upstream/main, agents-md-lean check passes (127 lines, 6,944 bytes). CI should be clean.

@formed2forge

Copy link
Copy Markdown
Contributor Author

@Git-on-my-level both items from your review are resolved — requesting a re-look:

  1. Rebase: branch was 408 commits behind; now reset to `upstream/main` + 1 commit (the Node pin note). All content from the original 8 commits that wasn't already in upstream via docs(desktop-windows): add AGENTS.md, index it from root, fix a stale release-pipeline.md claim #12034 has been applied.
  2. Line/byte budget: Node version pin condensed to a single line — 127 lines / 6,944 bytes, within the 127-line / 6,950-byte budget. `check_agents_md_lean.py` passes locally.

All 12 CI checks pass. Happy to adjust wording if anything looks off.

@Git-on-my-level
Git-on-my-level dismissed their stale review August 27, 2026 17:21

Both concerns from this review are resolved on the current head (2faa66f): the branch was rebased onto main (PR is now main + 1 commit), and the Node-pin paragraph was condensed to a single line, bringing desktop/windows/AGENTS.md to 127 lines / 6,944 bytes — inside the (127, 6,950) ratchet in .github/scripts/check_agents_md_lean.py.

@Git-on-my-level Git-on-my-level added positive-signal Good PR — positive signal, not a formal approval and removed docs-accuracy Documentation or committed reports need accuracy fixes labels Aug 27, 2026

@Git-on-my-level Git-on-my-level left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clean rebase — both items from my earlier review are resolved on this head, and I verified each independently:

  • Rebase: the branch is now main + 1 commit, and the net diff is exactly one added line in desktop/windows/AGENTS.md (the Node-pin note, placed right after the pnpm major-version pin paragraph).
  • Size budget: the file measures 127 lines / 6,944 bytes against the 127-line / 6,950-byte ratchet in .github/scripts/check_agents_md_lean.py — inside budget, and the condensation kept the actionable core (.nvmrc + nvm use, pretest guard).

I also re-checked every claim in the new line against the tree:

  • engines.node is >=22.19.0 <23 in desktop/windows/package.json
  • desktop/windows/.nvmrc is 22.19.0
  • pretest runs node scripts/check-node-version.mjs, and the script exists ✓ — its header documents the same Node ≥ 24 failure mode the note cites (Node's own experimental localStorage global shadows jsdom's), so the "Node 24+ breaks vitest" claim is corroborated by the guard itself ✓

One maintainer-facing note: this edits an agent instruction file. The new line will steer AI coding/review agents working in desktop/windows/ to select Node 22 before running the suite. I checked the guidance against package.json, .nvmrc, and the pretest guard — it's accurate, consistent with the adjacent pnpm-pin paragraph, and asks nothing of agents beyond version selection, so I consider it safe.

I've dismissed my earlier changes-requested review (both concerns resolved) and removed the docs-accuracy label. Checks are green on this head.


by AI on behalf of David — leaving formal approval to a human maintainer since this is an agent-guidance edit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

positive-signal Good PR — positive signal, not a formal approval windows Windows desktop work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants