Skip to content

Add reusable documentation toolkit - #29

Merged
andymeierdev merged 8 commits into
mainfrom
andymeierdev/add-documentation-toolkit
Aug 13, 2026
Merged

Add reusable documentation toolkit#29
andymeierdev merged 8 commits into
mainfrom
andymeierdev/add-documentation-toolkit

Conversation

@andymeierdev

@andymeierdev andymeierdev commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add the reusable FSharp.ViewEngine.Docs package for article, reference, canvas, API-reference, diagram, navigation, search, theme, story, validation, and executable-specification composition
  • migrate the documentation application to dogfood the package with source-faithful isolated examples, a component catalog, and full-page examples
  • expand core rendering APIs, XML documentation, tests, package verification, and benchmark coverage
  • harden the documentation site with accessible responsive navigation, desktop scrollspy, mobile table of contents, persistent light/dark/system themes, pinned local assets, and Tailwind Plus Elements examples
  • add accessibility automation, internal link and asset crawling, cross-browser CI, sitemap/robots endpoints, and social metadata

Verification

  • Release solution build: zero warnings and errors
  • core tests: 81 passed
  • documentation tests: 26 passed
  • Firefox Playwright suite: 58 passed
  • representative WCAG A/AA axe scans passed
  • source-faithful preview and link/asset integrity checks passed
  • both local packages packed and verified on .NET 10
  • git diff --check passed

Environment notes

  • local .NET 8 and 9 runtimes are unavailable; CI covers the documented .NET 8/9/10 matrix
  • local Chromium and WebKit Playwright binaries are unavailable; CI now installs and runs Chromium, Firefox, and WebKit

Independent package releases

  • Core and Docs now have separate manual publish workflows and independent calendar versions
  • Core retains vYYYY.M.MINOR tags; Docs uses docs/vYYYY.M.MINOR
  • Docs publication requires an explicit minimum published Core version and verifies that dependency in the generated NuGet package
  • package publication no longer deploys the documentation site
  • preview CI packs and verifies both packages with deliberately different versions

Release hardening

  • both publish workflows require an explicit package version and a matching released-package changelog entry
  • direct Docs packing fails unless explicit Docs and minimum Core versions are supplied
  • generated release notes start at the previous tag from the same package release train
  • package tags are created only after the verified NuGet package is published and available

@github-actions

github-actions Bot commented Aug 13, 2026

Copy link
Copy Markdown

🍹 preview on fsharp-view-engine/prod

Pulumi report

View in Pulumi Cloud

  Previewing update (prod)

View Live: https://app.pulumi.com/meiermade/fsharp-view-engine/prod/previews/15697b32-6edb-4ed0-9139-5f6a33e4fdf6

pulumi:pulumi:Stack: (same)
  [urn=urn:pulumi:prod::fsharp-view-engine::pulumi:pulumi:Stack::fsharp-view-engine-prod]
  ~ docker-build:index:Image: (update)
      [id=sha256:59c08fe493a66e70d4a5f8fe76d6022c2e053db11b573e20e6ab64b754b09fc2]
      [urn=urn:pulumi:prod::fsharp-view-engine::docker-build:index:Image::fsharpviewengine]
    - contextHash: "33a6af8c269c0097e524bbf3ff2eb9b89ead81072a4c9e2674e389e0f9515db3"
  ~ kubernetes:apps/v1:Deployment: (update)
      [id=fsharpviewengine/fsharpviewengine]
      [urn=urn:pulumi:prod::fsharp-view-engine::kubernetes:apps/v1:Deployment::fsharpviewengine]
    ~ spec: {
        ~ template: {
            ~ spec: {
                ~ containers: [
                    ~ [0]: {
                            ~ env  : [
                                ~ [0]: {
                                        ~ value: "2026.8.0" => "preview"
                                      }
                                ~ [1]: {
                                        ~ value: "f20feaf5a823881624e57cce338e860c0e02bfd7" => "c6aef938c6dbdb9dfbcf0450aecf0db83eefa720"
                                      }
                              ]
                            ~ image: "us-east1-docker.pkg.dev/meiermade-platform/platform/fsharpviewengine:latest@sha256:6ed90bed4c0ed044780975b1eff0fbf0886531b49c95d58edd407ab43c611c46" => [unknown]
                          }
                  ]
              }
          }
      }
Resources:
  ~ 2 to update
  8 unchanged
  

@andymeierdev
andymeierdev merged commit 3df68b5 into main Aug 13, 2026
3 checks passed
@andymeierdev
andymeierdev deleted the andymeierdev/add-documentation-toolkit branch August 13, 2026 16:12
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