Skip to content

Publish search-indexable HTML engineering documentation#19

Merged
masarray merged 8 commits into
mainfrom
agent/html-engineering-docs
Jul 12, 2026
Merged

Publish search-indexable HTML engineering documentation#19
masarray merged 8 commits into
mainfrom
agent/html-engineering-docs

Conversation

@masarray

@masarray masarray commented Jul 12, 2026

Copy link
Copy Markdown
Owner

Purpose

Complete the next repository-hardening phase by turning every Markdown engineering guide into a dedicated, indexable HTML page on GitHub Pages.

Changes

  • Add a repository-owned, dependency-free Python public-site builder.
  • Generate one canonical HTML page for every docs/*.md source file.
  • Generate compact documentation navigation, client-side topic filtering, breadcrumbs, source links, and responsive documentation styling.
  • Add per-page description metadata, Open Graph metadata, Twitter Card metadata, and TechArticle JSON-LD.
  • Generate a documentation search index and a multi-page sitemap containing the product homepage plus every documentation page.
  • Build the staged public site in CI and Pages instead of copying raw Markdown into the deployment artifact.
  • Add recursive validation for all HTML pages, structured data, canonical uniqueness, local links/assets, search-index targets, sitemap coverage, web-manifest icons, and robots metadata.
  • Link the product landing page directly to Quick Start, SV Profile Support, COMTRADE Replay, Subscriber Verification, Safety Boundaries, and the complete documentation index.

Validation completed

  • Public-site builder: success.
  • Recursive validation across the landing page and all generated documentation pages: success.
  • Canonical URL uniqueness, local asset/link checks, JSON-LD parsing, search-index targets, sitemap coverage, manifest icons, and robots metadata: success.
  • Publisher warning-free build: success.
  • Subscriber warning-free build: success.
  • Unit tests and protocol-core coverage regression gate: success.
  • Publisher and Subscriber dependency vulnerability reports: success.
  • Full-solution warning-free CodeQL build and analysis: success.

The Windows release workflow is intentionally not triggered because this PR changes only public-site, documentation, and validation paths. No public release is created by this pull request.

@masarray
masarray marked this pull request as ready for review July 12, 2026 02:02
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@masarray
masarray merged commit b5897fb into main Jul 12, 2026
3 checks passed
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.

1 participant