Package icon, docs site, and integrated docs CI#6
Merged
Conversation
- Bump <PackageIconUrl> to https://thargelion.net/assets/component-test.png - Add DocFX site under docs/ (test.tharga.net), modeled on Tharga.Mcp: index + 3 articles (getting-started, assignment-checks, dependency-tests), custom thg template for navbar logo sizing, generated api/ gitignored - Fold docs build + Pages deploy into build.yml as docs / docs-deploy jobs gated on `needs: release`, per the "integrated pattern from day one" guidance (Tharga.Runtime reference) - README links to test.tharga.net
|
Released as v1.14.10 — https://github.com/Tharga/Test/releases/tag/1.14.10 |
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
1 participant
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.
Bundles three pending requests from the central Requests notes (
Move PackageIconUrl to thargelion.net/assets,Documentation sites under tharga.net,CI: Publish docs after release succeeds) into one PR — mirroring thefeature/icon-and-docsbranch convention already used by Tharga.Mcp and Tharga.Runtime.Summary
<PackageIconUrl>switched tohttps://thargelion.net/assets/component-test.png(verified 200 / image/png).docs/, served attest.tharga.net. Modeled on Tharga.Mcp: landingindex.md, three articles (getting-started,assignment-checks,dependency-tests), API reference generated fromTharga.Test.Toolkit.csproj, customthgtemplate that constrains the navbar logo to 32px tall.docs/api/is generated per build and gitignored (matches Mcp's actualgit ls-filesstate — my initial plan to commit it was incorrect).docs+docs-deployjobs appended to.github/workflows/build.yml, both gated ongithub.ref == 'refs/heads/master' && github.event_name == 'push'.docsneeds: release, so docs only deploy after the NuGet release succeeds. No separatedocs.yml— adopts the integrated pattern from day one per the Requests guidance.Local checks:
dotnet build -c Releaseis clean (0 warnings);docfx docs/docfx.jsonbuilds 14 models (5 conceptual + 5 managed-reference + 3 TOC + CNAME resource) with 0 warnings / 0 errors.Manual follow-ups (cannot be done from a PR)
CNAME test.tharga.net → tharga.github.iogithub-pagesenvironment (typically auto-created on first deploy; verify after first run)Test plan
build,security,prerelease)1.14.9is published to NuGetdocs+docs-deployjobs run afterreleaseand the site is reachable at https://test.tharga.net