Skip to content

Document the six-screen maximum and seven main-window layouts #71

Closed

Description

@cchacs

Problem

The documentation understates the plugin's defining capacity and contradicts the v1.14.20 implementation.

At commit 191fb96e84b62395940dd3d0aed5842c99ae2fc7:

  • screen.js defines seven main-window layout choices spanning 2–6 panels: Top/Bottom, Left/Right, Tri 1+2, Tri 2+1, Quad, Five (2 over 3), and Six (3×2).
  • README.md still opens with “2–4 highway panels” and advertises “Five layouts” ending at Quad.
  • README.md's plugin-integration guidance says Split Screen may create “2–4 instances simultaneously.”
  • .specify/memory/constitution.md also says the plugin renders 2–4 panels.
  • The pop-out documentation says the popup has “the same layouts available in main,” then correctly lists only Single, Top/Bottom, Left/Right, and Quad. Popup layout support is narrower than main-window support and needs to be stated explicitly.

This stale summary caused the v1.14.20 release notes to initially omit the increase from four to six screens, even though it is the release's clearest user-facing benefit.

Required correction

  • Lead the README with support for 2–6 synchronized screens.
  • List all seven main-window layouts and describe Five as 2-over-3 and Six as 3×2.
  • Update integration guidance and maintained architecture/constitution text from 2–4 to 2–6 instances.
  • Describe popup layouts separately as Single/2/2/Quad, rather than saying they match the main window.
  • Add a documentation check or test assertion derived from LAYOUTS so the advertised maximum cannot silently drift from the implementation again.

The published v1.14.20 release has already been corrected.

Activity

  1. pullfrog commented on Sep 26, 2026

    @pullfrog
  2. self-assigned this
    on Sep 26, 2026
  3. added theissue type on Sep 26, 2026
  4. cchacs commented on Oct 1, 2026

    @cchacs
    CollaboratorAuthor

    @pullfrog please build this (Effort: Low). Correct the documentation as laid out in the issue: lead the README with 2–6 synchronized panels and the seven main-window layouts, fix the "2–4 instances" integration wording and .specify/memory/constitution.md, and state explicitly that pop-out windows offer a narrower layout set than the main window. Follow the repo's CLAUDE.md (README links point at got-feedBack, not this fork) and open a PR against main. Please don't merge it.


    Generated by Claude Code

  5. pullfrog commented on Oct 1, 2026

    @pullfrog

    Opened PR #76 against main (left open, not merged): #76

    Documentation corrected

    • README leads with 2–6 synchronized panels and lists all seven main-window layouts (Five as 2-over-3, Six as 3×2).
    • Pop-out section now states explicitly that a pop-out window's layout set is narrower than the main window's — Single/Top-Bottom/Left-Right/Quad, stopping at Quad — replacing the "same layouts as main" claim that contradicted the list right after it.
    • Path 2 integration rule and the constitution preamble: 2–4 → 2–6 instances.

    Also fixed, because the same claim was stale where users read it first: the plugin.json blurb ("2–4 synced panels"), the tour.json layout-picker step, and the screen.js module header. The Settings default-layout picker also stopped at Quad, so a saved five/six default couldn't be represented — both options added (patch bump to 1.14.22, which the repo's version-bump compliance gate requires for .js/.html changes).

    Drift guard — five tests derive the advertised surface from LAYOUTS/FOLLOWER_LAYOUT_PANELS: the README's range and layout count, the settings options, both picker option lists, and the pop-out set being a strict subset. Each was mutation-checked rather than just run green: renaming the follower map, adding a dead pop-out picker option, and adding a seven layout without doc updates each fail loudly. The first of those initially passed vacuously, so the parsers now assert a non-empty match.

    node --check screen.js clean; node tests/screen.test.js 187 pass, 0 fail. Left out of scope and noted in the PR body: the constitution's Principles IV/VI/VIII still describe the retired createJumpingTabPane/createTabView factories, its Governance section names the old topkoa repo, and CLAUDE.md:30/:46 under-describe LAYOUTS and the layout values.

    Task list (8/8 completed)
    • Create feature branch
    • Read the issue text thoroughly
    • Update README.md with 2–6 screens, seven main-window layouts, corrected integration wording, popup layout clarification
    • Update constitution.md from 2–4 to 2–6
    • Update settings.html default-layout dropdown to list all seven layouts
    • Add test pinning README's advertised max/layout count to LAYOUTS so it can't drift again
    • Run tests
    • Self-review diff, commit, push, open PR (do not merge)

    Pullfrog  | View workflow run | via Pullfrog | Using big-pickle (free) | 𝕏

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

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions