Skip to content

Docs site at reporter.tharga.net + PackageIconUrl migration#8

Merged
poxet merged 1 commit into
masterfrom
feature/docs-and-icon
Jun 7, 2026
Merged

Docs site at reporter.tharga.net + PackageIconUrl migration#8
poxet merged 1 commit into
masterfrom
feature/docs-and-icon

Conversation

@poxet

@poxet poxet commented Jun 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Bundles two requests from the meta-repo, following the Tharga.Console pattern (PR #35):

  • PackageIconUrlhttps://thargelion.net/assets/component-reporter.png (was a WordPress upload URL on thargelion.se).
  • DocFX site at reporter.tharga.net — landing page + 4 articles (getting-started, templates, elements, data-and-rendering) + API reference generated from Tharga.Reporter.csproj.
  • Logo trap fix — uses the absolute-URL approach with templates/thg/layout/_master.tmpl overlay that moves {{_rel}} into the fallback path only (DocFX 2.78.x bug — see Console PR #35).
  • CI integrationdocs + docs-deploy jobs added to build.yml, chained after release, gated on master push. pages: write + id-token: write permissions added.
  • README links to reporter.tharga.net and includes a short description.

Required setup before merging

  • DNS reporter.tharga.nettharga.github.io confirmed
  • GitHub Pages enabled in repo settings (Source: GitHub Actions)
  • component-reporter.png exists at https://thargelion.net/assets/ (verified HTTP 200 locally)

Test plan

  • Local: curl -I https://thargelion.net/assets/component-reporter.png200 OK
  • Local: docfx docs/docfx.json → 0 errors, 49 API files, 6 conceptual files
  • Local: sub-page logo URL is clean (src="https://thargelion.net/...", no ../https://... corruption)
  • Local: dotnet build -c Release → 0 errors, 15 warnings (under threshold)
  • Local: dotnet test -c Release → 6 passed, 44 skipped (legacy), 0 failed
  • CI green on PR (build + security + prerelease)
  • After merge: release publishes new patch with updated icon URL
  • After merge: docs deploy succeeds and reporter.tharga.net/articles/ loads with correct logo

Mirrors the Tharga.Console pattern (PR #35):

- PackageIconUrl in Tharga.Reporter.csproj now points at
  https://thargelion.net/assets/component-reporter.png (was a
  WordPress upload URL on thargelion.se).
- DocFX site under docs/ with index, 4 articles
  (getting-started, templates, elements, data-and-rendering),
  and API metadata generated from Tharga.Reporter.csproj.
- Absolute-URL logo via thargelion.net/assets, with the
  templates/thg/layout/_master.tmpl overlay that moves _rel into
  the fallback path only — fixes the ../https://... corruption
  on DocFX 2.78.x sub-pages.
- CNAME → reporter.tharga.net.
- build.yml gets pages: write + id-token: write permissions and
  two new jobs (docs, docs-deploy) chained after release.
- README links to reporter.tharga.net and includes a short
  description matching the docs landing page.
- .gitignore excludes docs/_site and docs/api (generated).
@codecov

codecov Bot commented Jun 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@poxet poxet merged commit cfa7a59 into master Jun 7, 2026
7 of 8 checks passed
@github-actions

github-actions Bot commented Jun 7, 2026

Copy link
Copy Markdown

Released as v2.3.6https://github.com/Tharga/Reporter/releases/tag/2.3.6

@poxet poxet mentioned this pull request Jun 8, 2026
3 tasks
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