Skip to content

docs: add what's new since modular SHAFT - #1029

Merged
MohabMohie merged 6 commits into
masterfrom
ChaosEngine/1028-whats-new-since-modular
Aug 26, 2026
Merged

docs: add what's new since modular SHAFT#1029
MohabMohie merged 6 commits into
masterfrom
ChaosEngine/1028-whats-new-since-modular

Conversation

@MohabMohie

@MohabMohie MohabMohie commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Tracks shafthq.github.io#1028: a What's new docs folder for user-facing features shipped since modularization (10.2.20260610), with a last page of poorly discovered older features.

This PR currently holds an empty tracking commit. Codex Terra implements next on this branch.

Closes #1028

Owner-locked spec

  • Sidebar category What's new after Start, before Testing; navbar What's new item.
  • Folder:
    • docs/features/whats-new/index.mdx — cover + mindmap mermaid + cards
    • platform.md — BOM, upgrader, project generator, properties generator
    • agentic.md — separate entries: Pilot, Capture, Doctor, Heal, MCP, CLI, IntelliJ, skills, ChaosEngine, providers, planning, natural-language actions
    • evidence.md — trace viewer, diagnostics, failure brief, locator health, flake profiler, Allure overview, Playwright traces
    • testing.md — Playwright backend, contract replay, remote SFTP/SSH, accessibility reports
    • modules.md — optional artifacts; shaft-ocr preview
    • missed.md — last page: Smart Locators, ARIA locators, Allure 3, localization assertions, other poorly discovered pre-cutoff items
  • Each feature: 3–4 line what / why / how / full-docs link. Mermaid and real screenshots are extra, not a second guide.
  • Headed capture authorized for Trace Viewer, Allure, and IntelliJ. Prefer fresh shots under static/img/whats-new/.
  • Quality tests own the entry format. Balanced check: yarn test:docs && yarn typecheck && yarn build.
  • Terminal adversarial review: on, two rounds max, after final scope commit.
  • Companion SHAFT_ENGINE PR (template + playbook sentence) after this URL exists. Related only, does not close New Features summary since the modular revamp #1028.
  • Stop at a ready PR with no conflicts and no open review comments. Owner peer-reviews and merges. No auto-merge.

Full inventory and TDD slices live on the issue body.

Checks

  • Tracking commit only at this HEAD. Implementation checks not run yet.

Continuation

  • Worktree: /media/mohab/OS/Users/Mohab/IdeaProjects/shafthq.github.io.1028-whats-new
  • Branch: ChaosEngine/1028-whats-new-since-modular @ f7b9177
  • Base: origin/master (344cb54)
  • Next: Codex Terra (gpt-5.6-terra) implements the folder, tests, mermaid, and screenshots on this PR.

Implementation checks

  • yarn test:docs — passed (run with temporary npx yarn@1.22.22 because the image has no global Yarn binary).
  • yarn typecheck — passed.
  • yarn build — passed.
  • npx playwright test tests/e2e/homepage.spec.js --project=chromium — passed: 9 tests.

Screenshots

Fresh built-site captures:

  • static/img/whats-new/catalog-desktop.png
  • static/img/whats-new/catalog-mobile.png
  • static/img/whats-new/setup-wizard-desktop.png
  • static/img/whats-new/setup-wizard-mobile.png
  • static/img/whats-new/properties-generator-desktop.png
  • static/img/whats-new/properties-generator-mobile.png

No headed product capture was attempted, so no failed-headed-capture issue was opened. Follow-up still needed for fresh Trace Viewer, Allure overview/dashboard/failure-brief, IntelliJ, Capture picker, and assertion-mode product UI shots; no fallback assets were used.

Empty tracking commit so the draft PR can carry the owner-locked spec
before Codex Terra implements the What's new folder.
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 26, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
shaft-engine 723c2ae Commit Preview URL

Branch Preview URL
Aug 26 2026, 09:25 PM

@MohabMohie

Copy link
Copy Markdown
Contributor Author

Remaining headed product shots from the owner-locked spec were not produced as live UIs in this PR. Follow-ups (one issue per missing shot):

The Allure overview image on the evidence page is a headed capture of the existing sample PNG (shaft-overview-sample.png) opened in Chrome, not a live Allure session. Independent adversarial review is running on this PR. Companion engine PR: ShaftHQ/SHAFT_ENGINE#5422. No auto-merge.

@MohabMohie

Copy link
Copy Markdown
Contributor Author

Independent adversarial review (round 1) on b7ab61b: request changes.

High (must fix before ready):

  1. docs/features/whats-new/evidence.md Allure image is Chrome viewing shaft-overview-sample.png (file URL, bookmarks, taskbar). Alt text claims a generated Allure report. Drop it or recapture a live overview without chrome.
  2. Native Playwright traces entry uses shaft.trace.* and the wrong how-to. Live keys are playwright.tracing.enabled (default false) and playwright.tracing.onRetryOnly (default true).
  3. Localization entry links Test Data Management, which has no locale workflow. Engine API is language/LTR-RTL validations.

Medium (fix in the same pass):
4. Truncated flake key: use shaft.flakeProfiler.failOnSevereFlakeRisk.
5. Capture entry missing /record, /codegen, pilot.ai.enabled=false.
6. Accessibility Full docs should be the GUI accessibility section, not /docs/testing/web.
7. Cover should use doc-card-grid cards, not only a bullet list.
8. MCP entry should name shaft-mcp.
9. Allure 3 compatibility how-to should match allure.forceConfiguredCliVersion / PATH 2.x, not a vague report-mode toggle.
10. Quality tests do not lock navbar/mermaid/property strings (optional this round if 1–9 land).

Do not commit worktree src/main/. Screenshot follow-ups stay #1033 #1031 #1032 #1030.

@MohabMohie
MohabMohie marked this pull request as ready for review August 26, 2026 20:36
@MohabMohie
MohabMohie marked this pull request as draft August 26, 2026 20:36
@MohabMohie

Copy link
Copy Markdown
Contributor Author

Review round 1 addressed on ef21b67:

  • Removed the file-URL Allure sample image
  • Playwright traces now use playwright.tracing.enabled / playwright.tracing.onRetryOnly
  • Deleted the invented localization/test-data entry
  • Full shaft.flakeProfiler.failOnSevereFlakeRisk key
  • Capture how-to includes /record, /codegen, pilot.ai.enabled=false
  • Accessibility Full docs point at the GUI accessibility section; example uses .accessibility()
  • Cover uses doc-card-grid
  • MCP names shaft-mcp
  • Allure 3 how-to uses allure.forceConfiguredCliVersion

Independent re-review (round 2 of 2) is running. PR stays draft until that verdict. No auto-merge.

@MohabMohie

Copy link
Copy Markdown
Contributor Author

Independent review round 2 (cap): remaining medium/low, not a third review round.

  1. Playwright traces: playwright.tracing.enabled=true starts a full-session trace. Retry ZIPs already attach with default enabled=false + onRetryOnly=true. How-to should match Playwright_Backend.md.
  2. Recapture catalog-desktop.png / catalog-mobile.png after the doc-card change; current shots still show the bullet list.
  3. Allure 3 allure.forceConfiguredCliVersion is not on /docs/reference/reporting; link the properties catalog (or the section that actually names the key).

Round-1 highs stay closed. Screenshot follow-ups stay #1030#1033. Codex Terra will apply these three, then this PR can go ready for human peer review.

@MohabMohie

Copy link
Copy Markdown
Contributor Author

Round-2 residuals landed on 0e52953 (verified in the worktree, no third review round):

  • Playwright traces how-to matches defaults: retry ZIPs with onRetryOnly=true; enabled=true only for a full session. Full docs: Playwright backend.
  • Cover desktop/mobile shots recaptured; they show the doc-card grid.
  • Allure 3 Full docs: Properties catalog #allure.

Independent review cap (2 rounds) is done. This PR is marked ready for human peer review. No auto-merge.

Product UI follow-ups remain #1030#1033. Companion: ShaftHQ/SHAFT_ENGINE#5422.

@MohabMohie
MohabMohie marked this pull request as ready for review August 26, 2026 20:47
Replace the cover mermaid mindmap with a token-colored, fully linked map,
remove embedded screenshots of the catalog page, and keep group diagrams on
the site palette with clickable section targets.
@MohabMohie

Copy link
Copy Markdown
Contributor Author

SOLO follow-up on 723c2ae:

  • Cover map is a token-colored, keyboard-accessible nav. Every group and child node is a real link to the matching catalog section.
  • Removed self-screenshots of the What's new page.
  • Group Mermaid diagrams stay on the site palette and now include section clicks.
  • Checks: docs-quality, typecheck, yarn build, Playwright whats-new-map.spec.js (2 passed).

Merging on green.

@MohabMohie
MohabMohie merged commit dac6c8c into master Aug 26, 2026
6 checks passed
@MohabMohie
MohabMohie deleted the ChaosEngine/1028-whats-new-since-modular branch August 26, 2026 21:25
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.

New Features summary since the modular revamp

1 participant