Skip to content

Add docs preview job and documentation image tests - #235

Merged
todi1856 merged 10 commits into
masterfrom
preview-docs
Nov 13, 2026
Merged

todi1856 merged 10 commits into
masterfrom
preview-docs

Conversation

@todi1856

@todi1856 todi1856 commented Nov 13, 2026 •

Copy link
Copy Markdown
Member

Yamato CI Docs preview

Jira: PLAT-23714

Docs preview job

Adds .yamato/docs.yml#build_docs, which builds the package documentation (manual and API reference) with packagedocs-cli, the same tooling that produces the published package docs.

  • Output is stored as the docs artifact. There's no hosted preview service for package docs, so download the artifact and open docs~/com.unity.mobile.android-logcat@<version>/manual/index.html.
  • The Editor log is stored as the logs artifact.
  • package-manager-doctools is pinned to its stable tag through DOCTOOLS_REVISION. Without it the CLI takes HEAD, which timed out on 6000.0.
  • Runs on PRs into master that touch Documentation~/ or .cs files in the package.
  • prefill-pr.yml adds a "Docs preview" badge next to the Yamato CI badge, linking to this job on the PR's branch.

Documentation image tests

New AndroidLogcatDocumentationTests:

  • AllReferencedImagesExist: every image referenced from a .md file exists. Compared case-sensitively, since the docs are built and served on case-sensitive file systems.
  • AllImagesAreReferenced: every file in Documentation~/images is used by some page.
  • AllImageNamesAreLowerCase: image file names are lower case.

Documentation fixes the tests found

  • Renamed 14 images to lowercase-hyphenated names, e.g. InputsWindow_SendText.png → inputs-window-send-text.png. This also fixes inputs-window.md, which referenced inputswindow.png and only worked on case-insensitive file systems.
  • Referenced again images dropped by earlier rewrites: memory-groups.png (Memory groups), android-logcat-send-unix-signal.png (Terminate an application) and android-logcat-app-trim-memory.png (Send trim memory). The trim memory screenshot is retaken, as the old one showed Kill with signal instead of Send Unix signal.
  • Removed memory-window-capture.png (identical to memory-window-details-panel.png) and label-c.png (no page labels a third area).

🤖 Generated with Claude Code

@u-pr u-pr Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Harness Review

Ship it

The change adds a Yamato documentation build with downloadable artifacts and a PR badge linking to the job. I examined the badge construction, build commands, artifact paths, PR triggers, and consistency with existing CI and package requirements.

Reviewed commit 9fc9d3c

🤖 Helpful? 👍/👎

todi1856 and others added 5 commits November 13, 2026 12:55
Check that every referenced image exists (case-sensitively), that every
image in Documentation~/images is referenced, and that image names are
lower case.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Also fixes the inputs window image reference, which only matched
InputsWindow.png on case-insensitive file systems.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
memory-groups.png is shown again in the Memory groups section.
memory-window-capture.png duplicated memory-window-details-panel.png, and
label-c.png has had no table to label since the Screen Capture window
reference dropped its A/B/C labels.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The Send Unix signal and Send Trim Memory images were left unreferenced
by an earlier docs rewrite. The trim memory screenshot is retaken, as
the old one still showed "Kill with signal".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
package-manager-doctools at HEAD timed out on 6000.0. The CLI installs
the Editor itself, so the explicit download steps are gone.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@todi1856 todi1856 changed the title Add Yamato job to preview generated docs Add docs preview job and documentation image tests Nov 13, 2026
todi1856 and others added 3 commits November 13, 2026 13:21
The Editor resolved docs~/pmdt_status.json against its temporary
project, where docs~ doesn't exist. The write threw, and the job failed
with a 300 second timeout.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
DocFX loads the sidebar with a request browsers block for pages opened
from disk, so the docs artifact now includes scripts that serve it over
HTTP and open the manual.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@todi1856
todi1856 requested a review from anjalin14 November 13, 2026 12:03
browsable: always unzips the docs when the job ends, so the artifact
viewer can serve them without a manual Unzip. docs~/index.html redirects
to the manual of the version just built, so the URL doesn't depend on
the package version.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@todi1856
todi1856 merged commit eafc366 into master Nov 13, 2026
11 of 24 checks passed
@todi1856
todi1856 deleted the preview-docs branch November 18, 2026 12:10
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.

2 participants