Skip to content

docs(product-docs): assembler operator help HTML-first/Markdown/Velocity (#4433) - #4437

Merged
natechadwick-intsof merged 1 commit into
mainfrom
feat/issue-4433-assemblers-operator-help
Sep 9, 2026
Merged

natechadwick-intsof merged 1 commit into
mainfrom
feat/issue-4433-assemblers-operator-help

Conversation

@natechadwick-intsof

Copy link
Copy Markdown
Collaborator

Summary

Operator-facing product-docs 8.2 for choosing HTML-first, Markdown, or Velocity assemblers on Design / Developer Templates, matching shipped 8.2 (Design SPA picker + REST create default).

  • Extended Design templates (id: admin-design-templates) with assembler catalog, when-to-choose, placeholder syntax, JEXL note, change steps, and specialized/legacy picker rows.
  • Developer Templates: assembler is read-only there; change it on Design; Velocity snippets belong on Velocity templates.
  • Getting Started first-steps + glossary terms.
  • Did not edit pipeline hot-path files (product-docs/8.2/developer/rest.md, admin/developer-pipelines.md, admin/index.md, developer/index.md, WebUI, sitemanage-beans.xml, perc-qa-automation package.json).
  • Did not delete PSLegacyDefinitionXmlShim (Phase 5 residual: remove definition-XML dual-run shim when criteria met #2852).

Fixes #4433
Parent: #2632
Grandparent: #2626
Siblings (untouched): #4434, #4435

Operator: Grok: night-issue-prs (model grok-4.6)

Test plan

  1. Review product-docs/8.2/admin/design-templates.md assembler section against Design SPA Assembler list (HTML-first ★ default, Markdown ★, Velocity ★, Page, Legacy / XSL, Binary, Dispatch, Database).
  2. Confirm in-page fragment #choose-an-assembler-html-first-markdown-velocity and id: links to admin-design-templates, admin-developer-templates, developer-rest, reference-glossary.
  3. From repo root: scripts/ci-smoke-product-docs.sh (Windows: scripts\ci-smoke-product-docs.bat).
  4. Built HTML shows <code>${title}</code> / ${dotted.path} (entities in source) and heading id choose-an-assembler-html-first-markdown-velocity.

Checklist

  • Product documentation — updated pages under product-docs/8.2/ (admin/design-templates.md, admin/developer-templates.md, getting-started/index.md, reference/glossary.md)
  • Unit / module tests — N/A (docs-only; no production logic)
  • WebUI + Playwright — N/A (no WebUI product screen change)
  • Build gates — N/A (no Maven module sources/tests/POM changed). Docs smoke: scripts/ci-smoke-product-docs.sh OK — Built 48 page(s), found tmp/product-docs-site/8.2/index.html
  • Cross-platform — N/A (Markdown content only; smoke wrappers already have .sh / .bat)

C3 evidence

  • modules_built= (none — not a Maven change)
  • build_evidence= cd worktree root; bash scripts/ci-smoke-product-docs.sh → ci-smoke-product-docs: OK — found …/tmp/product-docs-site/8.2/index.html (Built 48 page(s))
  • downstream_checked= none (C2 API shape did not apply)

C5 UI proof

N/A — product-docs only; no WebUI / Playwright surface.

Erlang

docs/ai-generated/code-reviews/issue-4433-assemblers-operator-help-erlang.md — approve; May commit/push: yes.

Co-Authored by Grok Build 1.0.24 using grok-4.6 with agent night-issue-prs.

…ity (#4433)

Document Design SPA assembler choice on the existing Design templates page
(stable id admin-design-templates): HTML-first default, Markdown, and
Velocity preferred over Legacy/XSL. Cross-link Developer Templates,
Getting Started, and glossary. Do not touch pipeline hot-path pages.

Fixes #4433
Parent: #2632
Grandparent: #2626

> Co-Authored by Grok Build 1.0.24 using grok-4.6 with agent night-issue-prs.
@natechadwick-intsof natechadwick-intsof added documentation Improvements or additions to documentation operator:grok Changes authored by Grok operator:night-issue-prs night-issue-prs workflow model:grok-4.6 Session model grok-4.6 labels Sep 9, 2026
@natechadwick-intsof
natechadwick-intsof merged commit 2656286 into main Sep 9, 2026
5 of 6 checks passed
@natechadwick-intsof
natechadwick-intsof deleted the feat/issue-4433-assemblers-operator-help branch September 9, 2026 13:58
natechadwick pushed a commit that referenced this pull request Sep 19, 2026
…#4594)

README status table still showed Phase 1 in progress and Phases 2-5
blocked, although Phases 0-4 are closed and all six Phase 5 docs slices
merged (#2845/#2851/#2853/#4437/#4442/#4445). Mark phases done, point
operators at the live product-docs help pages, and keep the #2852
shim-removal hard gate explicit.

Fixes #2632
Parent: #2626

> Co-Authored by OpenCode 1.18.31 using muse-spark-1.3-contributor-free with agent night-issue-prs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation model:grok-4.6 Session model grok-4.6 operator:grok Changes authored by Grok operator:night-issue-prs night-issue-prs workflow

Projects

None yet

Development

Successfully merging this pull request may close these issues.

issue 2632 slice 4: product-docs assemblers operator help (HTML-first/Markdown/Velocity)

1 participant