Pinega Web Gate 2: Documentation Reorganisation and Review - #22
Merged
Conversation
likern
marked this pull request as ready for review
August 7, 2026 15:57
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
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
Implements Gate 2 — Documentation Reorganisation and Review from the accepted Web content audit on top of merged Gate 1.
The former mixed Getting Started article is decomposed into a real documentation corpus with separate Start/Tutorial, How-to, Concepts/Explanation, Reference, and Contributing content. Native HTML remains the durable article-body source; content-registry schema v2 is the single discovery/navigation metadata contract.
Documentation corpus
The schema reserves Tutorials as a first-class section, but no empty Tutorials landing is published merely to complete a taxonomy.
Content contract v2
Every documentation route carries:
documentation.section;documentation.purpose;documentation.order;documentation.applies_to;documentation.related.Build-time generation now owns repeated documentation chrome and discovery projections:
/docs/;aria-current;content/documentation-manifest.json;site-manifest.json.Article prose remains native semantic HTML.
UX/content decisions
/docs/getting-started/is now orientation only; task procedures, explanations, tutorials, and reference data have explicit owners./docs/filters real canonical pages, not anchors or external placeholders.Search/publishing readiness
content/documentation-manifest.jsonprovides a stable documentation-only projection containing route, title, summary, section, purpose, applicability, topics, programme, maturity, update date, authors, and related IDs. Later Blog, paper/PDF, and site-wide-search gates can extend/consume the same route and discovery model instead of inventing a second catalogue.Final validation
Final head:
All applicable final-head gates pass:
31194256719— success;31194257613— success.The Web gate passed token generation checks, strict TypeScript, unit/architecture contracts, static build and budgets, Chromium desktop/mobile, Firefox, WebKit, accessibility, committed visual baselines, checksums, and artifact upload.
The final website artifact was downloaded and its complete
artifacts/SHA256SUMS.txtmanifest verifies successfully.Review artifacts
Website / documentation
Workflow run:
31194256719Artifact:
pinega-website-v0.2-pull_request9000314796;sha256:e1cae7bde67d66b6f943df277b103674428a166d7befdde1ec464fc6d9d16b89.Primary visual-review baselines include:
docs-corpus-chromium-desktop-linux.png;docs-project-overview-chromium-desktop-linux.png;getting-started-chromium-desktop-linux.png;docs-run-validation-chromium-desktop-linux.png;The Gate 2 documentation surfaces were visually inspected after baseline generation; no blocking hierarchy, overflow, provenance, or composition defect remains.
Scientific Diagram Language compatibility
Workflow run:
31194257613Artifact:
scientific-diagrams-pr-22-bbf4b93f35d4-attempt-19000139634;sha256:2be9ac41e0921e9553dba97ab9eb6931f6f99fa64d700098fe01c7f5c1313613.This is a compatibility gate only: Gate 2 does not add a diagram family or promote a new layout.
Explicit non-goals
Status: ready for review.