Apply facto-stack Antora compose to docs.opensh.org hub - #1
Merged
Merged
Conversation
Merge DevCentr/facto-stack compose: indexify URLs, site-nav-tree with curated OSO sidebar roots, nav-typology, page-context, link tooling, mermaid-client, diagram-lightbox, and Kroki for non-Mermaid diagrams. Point grammaton docs at Desktop-Tooling/grammaton-ui-shell. Co-authored-by: Ryan Johnson <AMDphreak@users.noreply.github.com>
Copy nav-typology and site-nav-tree companion partials, helpers, and scripts from the DevCentr docs pattern. Wire mermaid-client and diagram-lightbox via head/footer partials; drop legacy site-mermaid assets. Co-authored-by: Ryan Johnson <AMDphreak@users.noreply.github.com>
Add verify-themed-svg-dark-mode Antora extension, vendored @dev-centr/themed-svg browser runtime, sync/check scripts, shell-architecture upstream diagram audits, and CI diagram-audit job. Document upstream theme manifest fix for label colors. Co-authored-by: Ryan Johnson <AMDphreak@users.noreply.github.com>
Clarify antora-diagram-engines (Mermaid client, lightbox) plus Kroki for PlantUML; themed-SVG assets stay on the upstream bake pipeline, not alternate AsciiDoc renderers. Co-authored-by: Ryan Johnson <AMDphreak@users.noreply.github.com>
Pass PUPPETEER_ARGS --no-sandbox when CI runs upstream shell-architecture mermaid-cli checks; mirror env on diagram-audit and Antora build jobs. Co-authored-by: Ryan Johnson <AMDphreak@users.noreply.github.com>
Remove shell-architecture clone diagrams:check and Puppeteer CI workarounds. Hub diagram-audit keeps themed-svg runtime sync, static dark-text audit, verifier tests, and Antora verify-themed-svg-dark-mode only. Co-authored-by: Ryan Johnson <AMDphreak@users.noreply.github.com>
Add CONTRIBUTING.md and scripts/DIAGRAM-AUDITS.md: no mermaid-cli/Puppeteer on Actions; point contributors to shell-architecture local diagrams:check. Co-authored-by: Ryan Johnson <AMDphreak@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Brings
openshellorg/docsto facto-stack parity with dev-centr/docs for https://docs.opensh.org.Playbook
indexifyURLs, Lunr,unversioned-component-urls, site-nav-tree (curated roots), nav-typology (+ Diátaxis), build-stack, verify-themed-svg-dark-mode, page-context/edit, link tooling, mermaid-client + diagram-lightbox (antora-diagram-engines), asciidoctor-kroki for PlantUML/other Kroki types.site.keyspreserved; Grammaton sourceDesktop-Tooling/grammaton-ui-shell.Diagram rendering engines (not hub bake of upstream Mermaid)
[source,mermaid]@antora-supplemental/mermaid-clientasciidoctor-kroki@antora-supplemental/diagram-lightbox[.themed-svg]committed figures@dev-centr/themed-svgruntime onlyThe hub does not clone shell-architecture to re-run
pnpm diagrams:check/ mermaid-cli / Puppeteer. Mermaid.mmd↔ committed SVG freshness is owned by humans and shell-architecture CI on developer machines.Contributor docs: CONTRIBUTING.md, scripts/DIAGRAM-AUDITS.md, and shell-architecture diagrams/README.adoc.
Hub diagram CI (
diagram-auditjob)pnpm diagrams:sync+pnpm diagrams:check:all(runtime sync, static dark-text audit, unit tests — no Chromium)verify-themed-svg-dark-modewarningsSupplemental UI
Facto nav-tree / typology companions; mermaid-client + diagram-lightbox partials; OSO branding retained.
Verification
pnpm diagrams:check:allandantora --fetch antora-playbook.ymlsucceed without Puppeteer.diagram-audit+ Antora build green on this branch.