Skip to content

In-context help: how-it-works page, leads, legend tooltips and help links from the docs map (#143) - #151

Merged
Arthurvdv merged 4 commits into
mainfrom
wp16/help
Oct 28, 2026
Merged

Arthurvdv merged 4 commits into
mainfrom
wp16/help

Conversation

@Arthurvdv

Copy link
Copy Markdown
Member

Closes #143. Last child of WP16 (#136).

What

  • how-it-works/ (content adapter + layouts/how-it-works/single.html, main.page-help): one screen on levels, stages, cells and their markers, and the cart. Each paragraph ends with a link from the docs map of rulebook.json (levels, alProject, dashboard, changingARule); the markers also link overrides, twins and quarantine. The header Help link, the landing card "How this works" and the legend open it. Publish requests it in the reachability check (37 URLs in the shipped set).
  • A lead under every title: the stage and level pages get a sentence that says what the page shows, with the data file's description below it (p.intro).
  • Legend tooltips: the five markers are focusable span.tip[role=img] whose aria-label is the explanation; site.css shows it on hover and on keyboard focus without JavaScript.
  • Help links: partials/help-link.html writes a ? (a.help-link, aria-label="Help: <topic>") after the section headings of the stage, level, rule and setup pages, with the href of a docs key and an optional heading id; no site file names a URL.
  • Deploy test: alcops.dev joins the forbidden literals of template/site/.
  • Counts: fixture 40 pages, shipped template 638 (Pin the template file and page counts in a test; list every issueState value of ApplyChangeSet #124 pin stages + levels + rules + 3); the Hugo stand-in, the Publish.Action tests and the CI publish-action checks follow; template files 99, site/ 33.
  • Docs: docs/dashboard.md sections 1 to 4 finished for WP16, with the design notes of WP16: Site redesign #136 and its children and one line per deviation; template/docs/dashboard.md section 1 lists the page, the tooltips and the help links; release note.

Tests

  • Pester (-Output Normal): Rulebook.Site 55, Rulebook.Deploy 76, Publish.Action 52, Rulebook.Publish 100, Rulebook.Template 77, Docs 340. The real-Hugo case ran (Hugo 0.165 extended).
  • node --test tests/site/: 35 passed (unchanged).
  • Playwright on the fixture build: 39 of 39. Covered: layout at 1280 and 390 px in both schemes, the leads, links equal to the data file, Help, the landing card and the legend landing on the page, tooltips on hover and focus with no title, the stage summary named by its heading text, the page without JavaScript, no foreign request, no page error. Screenshots: WP16: in-context help (How this works page, leads, legend tooltips, deep links to alcops.dev) #143 (comment)

Deviations

Listed in the comment on #143:

Review

Sonnet code-review round 1 found no must-fix. The should-fix items and the nits are applied in 0b337a5:

  • The tooltips come from aria-label, with no title.
  • The stage summary section is labelled by its heading text only.
  • The how-it-works wording is fixed.
  • how-it-works/ is in the reachability manifest (36 → 37 URLs).

🤖 Generated with Claude Code

Arthurvdv and others added 4 commits October 28, 2026 23:23
…he docs map (#143)

how-it-works/ (content adapter, kind help) explains levels, stages, cells and
the cart in one screen; every paragraph ends with a docs map link. The header
Help link, the landing card and the legend open it. Stage and level pages get
an explanatory lead with the data description below it; the five legend
markers carry a title and show it on hover and focus without JavaScript;
section headings of the stage, level, rule and setup pages get a "?" link
(partials/help-link.html) whose target comes from rulebook.json.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…nd alcops.dev as a forbidden site literal (#143)

The fixture builds 40 pages and the shipped template 638 (#124 pin: stages +
levels + rules + 3); the Hugo stand-in writes how-it-works/index.html. The
real-Hugo case checks the help page, its four docs map links, the header Help
link, the legend tooltips and that every help link starts with a docs map
value whose section exists on the template page. The Deploy test forbids an
alcops.dev literal in site files; CI checks the help page of the publish run.
Template file counts: 99 files, 33 under site/.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…what shipped; the help on the user page; release note (#143)

docs/dashboard.md gains the WP16 goal and site constraints (section 1), the
decisions of the WP16 interviews (section 2), why the site carries no
documentation (section 3, D58), the help bullet, the how-it-works and help
link views, the page kinds and leads, and a subsection that lifts the design
notes of #136 and its children with one line per deviation. The user page
lists how-it-works/, the tooltips and the help links.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…its heading text, how-it-works/ in the reachability check (#143)

The legend markers carry the explanation as aria-label and no title (no
second tooltip, a full accessible name); site.css shows attr(aria-label). The
stage summary section is labelled by a span around the heading text, so the
help link is not part of its name. how-it-works/ wording: a stage can adjust
the level result, the cart opens a prefilled issue form. Publish requests
how-it-works/ too (37 URLs in the shipped set); docs follow.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

WP16: in-context help (How this works page, leads, legend tooltips, deep links to alcops.dev)

1 participant