Skip to content

Package icon, docs site, and integrated docs CI - #35

Merged
poxet merged 4 commits into
masterfrom
feature/icon-and-docs
Jun 7, 2026
Merged

poxet merged 4 commits into
masterfrom
feature/icon-and-docs

Conversation

@poxet

@poxet poxet commented Jun 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

Bundles the two 2026-06-01 Internal requests for this repo, modeled on Tharga.Test commit d6b9efb:

  • PackageIconUrl — all three csproj files (Tharga.Console, Tharga.Console.Standard, Tharga.Console.Speech) updated from the old http://thargelion.se/wp-content/uploads/... WordPress URL to https://thargelion.net/assets/component-console.png.
  • Documentation site — DocFX docs/ tree, CNAME → console.tharga.net, 4 articles (getting-started, commands, consoles, dependency-injection) + API reference across all three csprojs. Custom templates/thg for navbar logo sizing.
  • Integrated docs CI — docs + docs-deploy jobs added to .github/workflows/build.yml, gated on needs: release so they only run when a published version succeeds. pages: write + id-token: write permissions added at the workflow root.
  • README — single **Docs:** link near the top, matching the sibling pattern (Test, Communication).

Pre-reqs verified

  • https://thargelion.net/assets/component-console.png returns 200 OK (Cloudflare HIT).
  • console.tharga.net resolves via DNS.

Test plan

  • dotnet build -c Release clean (0 warnings, 0 errors across net8/net9/net10 + netstandard2.0).
  • dotnet test -c Release — 44 pass / 0 fail / 2 pre-existing skips.
  • Local DocFX smoke-build (docfx docs/docfx.json) — 0 errors, 1 benign warning about project-reference load order.
  • After merge: CI publishes a 4.1.x patch, then docs + docs-deploy jobs run and console.tharga.net serves the new site.
  • One-time: confirm GitHub Pages cert is approved + HTTPS enforced for console.tharga.net (same step Tharga.Test mentioned in its status entry).

poxet added 2 commits June 7, 2026 16:16
- Bump <PackageIconUrl> in all three csproj files to
  https://thargelion.net/assets/component-console.png
- Add DocFX site under docs/ (console.tharga.net), modeled on Tharga.Test:
  index + 4 articles (getting-started, commands, consoles,
  dependency-injection), custom thg template for navbar logo sizing,
  generated _site/ + api/ + obj/ gitignored
- Fold docs build + Pages deploy into build.yml as docs / docs-deploy
  jobs gated on `needs: release`, per the integrated-pattern guidance
  used in Tharga.Runtime and Tharga.Test
- README links to console.tharga.net
DocFX 2.78.5's modern _master.tmpl prepends _rel (the relative-depth
prefix, e.g. "../") to _appFaviconPath and _appLogoPath without
checking whether the configured value is already an absolute URL. On
sub-pages that turned

  src="https://thargelion.net/assets/component-console.png"

into

  src="../https://thargelion.net/assets/component-console.png"

which 404'd, surfacing the broken-image alt text in the navbar so
the brand name appeared twice (alt-text + the {{_appName}} label).

Overlay a templates/thg/layout/_master.tmpl that moves _rel into the
fallback path only — absolute URLs render as-is, the local
logo.svg/favicon.ico fallbacks still resolve from the site root.
@poxet
poxet merged commit 98989a5 into master Jun 7, 2026
6 of 7 checks passed
@github-actions

github-actions Bot commented Jun 7, 2026

Copy link
Copy Markdown

Released as v4.1.2 — https://github.com/Tharga/Console/releases/tag/4.1.2

@poxet
poxet deleted the feature/icon-and-docs branch June 7, 2026 16:22

This branch had an error being deployed

1 failed deployment
prerelease — e05d2145 Deployed Jun 7, 2026 by poxet via prerelease #22
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