Skip to content

Docs-Sync #394: the demo's guided walkthrough is undocumented on the live-demo page and in the E2E catalogue #400

Closed as not planned

Description

@Sev7eNup

Source PR: #394 ("Serve the project website from real addresses and harden its hosting").

Affected doc surfaces: src/nodepilot-docs-ui/content/{de,en}/getting-started/live-demo.md, README.md (Live demo) and docs/testing/E2ETests.md (Teil 85).

The PR documented the browser demo well — a new bilingual live-demo page with its nav entry and both locale titles, a README section, Teil 85 in the E2E catalogue, a prose paragraph in e2e/README.md, and the CLAUDE.md map entries. The objective drift it left behind (README's 43 pages, and CONTRIBUTING's two-build description of assemble:site) is corrected in the docs-sync PR for this window.

What no surface mentions is the demo's guided walkthrough, which the same PR shipped:

  • src/nodepilot-ui/demo/ui/tour.ts — a three-stage guided task ("Deliver your file" → "Understand your result" → "Find the cause"), badged GUIDED DEMO · 2 MINUTES, with full DE/EN copy and a multiple-choice diagnosis step.
  • Started from a Guided tour / Geführter Einstieg button in the demo bar (demo/ui/banner.ts, wired in demo/main.demo.ts).
  • Driven by its own seeded workflow, scripts/example-guided-file-workflow.json — which scripts/README.md does describe, as the only surface that names the flow at all.
  • Covered by src/nodepilot-ui/e2e-demo/guided-tour.spec.ts, and given a route of its own on the project website (experience → /walkthrough in SITE_ROUTE_SEGMENTS).

None of that is wrong anywhere today — it is simply absent from the pages a reader would go to. Flagged rather than fixed because every option is authoring or an editorial placement call, not a reconciliation.

Findings (not auto-applied)

  • src/nodepilot-docs-ui/content/en/getting-started/live-demo.md and .../de/... — the What you can do list enumerates browsing the five sample workflows, the designer surface, edit-and-publish, running a workflow, CRUD on the other entities and the derived history screens, but never mentions that the demo offers a guided walkthrough at all. A reader who opens the demo meets a Guided tour button the documentation has not prepared them for. Not auto-applied: the fix is new bilingual user-facing prose describing a flow, including how much of the three-stage task to reveal without spoiling its diagnosis step, and it has to be written twice in matching register. Whether the walkthrough even belongs on this page or on the website's own /walkthrough route (which exists for it) is a content-placement decision.
  • README.md, Live demo section — same omission, one level shallower. The section sells "build a workflow, publish it, run it and watch the canvas light up" and does not mention the guided route in. Not auto-applied: depends on the decision above; the README deliberately keeps this section short, so a sentence may be unwanted rather than missing.
  • docs/testing/E2ETests.md, Teil 85 — the part is titled Browser-Demo gegen das veröffentlichte Bundle and its eight numbered checks map one-to-one onto e2e-demo/demo-smoke.spec.ts. The sibling spec e2e-demo/guided-tour.spec.ts runs in the same suite (npm run test:e2e:demo covers both files) and has no entry anywhere in the catalogue. Not auto-applied: whether that becomes a Teil 86, a set of 85.x checkpoints, or is deliberately left out is a test-plan decision. E2ETests.md is a manual acceptance plan, not an index of spec files, so "a spec exists" does not by itself establish that a part is owed — and adding one means authoring the manual steps and their expected results.
  • src/nodepilot-ui/e2e/README.md, Coverage map — the map ends at Teil 83 and carries no row for Teil 85. The demo suite is instead described in prose above the map, with the reasoning for why it lives in e2e-demo/. Not auto-applied: that looks deliberate — the map's own preamble scopes it to the hermetic SPA specs in e2e/ — so adding a row may contradict the structure on purpose. Note the separate missing Teil 84 row is already handled: it is pending in open PR docs: sync after #389 (script-editor skin coverage row) #393 and tracked in Docs-Sync #389: manual E2E part 84 still covers two skins while the spec runs five plus two switch cases #391, and is not part of this finding.

Automated docs-drift finding from the nightly documentation-sync run (window 2026-09-20T01:07Z → 2026-09-21T03:07Z); needs triage.

Activity

  1. Sev7eNup commented on Sep 22, 2026

    @Sev7eNup
    OwnerAuthor

    Triaged and not pursued. Every remaining item here is an authoring or product decision rather than a factual drift, and nothing in the repository is wrong today: the manual E2E plan is an acceptance plan and not an index of spec files, docs/av-exclusions.md deliberately declines to recommend excluding a randomised temp directory, and the settings and background-service inventories are curated rather than exhaustive. Closing as won't do so the triage queue reflects that decision instead of carrying it indefinitely.

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions