Repository navigation
Add docs preview job and documentation image tests - #235
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
💡 Harness Review
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? 👍/👎
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>
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>
anjalin14
approved these changes
Nov 13, 2026
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>
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
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.
Jira: PLAT-23714
Docs preview job
Adds
.yamato/docs.yml#build_docs, which builds the package documentation (manual and API reference) withpackagedocs-cli, the same tooling that produces the published package docs.docsartifact. There's no hosted preview service for package docs, so download the artifact and opendocs~/com.unity.mobile.android-logcat@<version>/manual/index.html.logsartifact.package-manager-doctoolsis pinned to itsstabletag throughDOCTOOLS_REVISION. Without it the CLI takesHEAD, which timed out on 6000.0.masterthat touchDocumentation~/or.csfiles in the package.prefill-pr.ymladds 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.mdfile exists. Compared case-sensitively, since the docs are built and served on case-sensitive file systems.AllImagesAreReferenced: every file inDocumentation~/imagesis used by some page.AllImageNamesAreLowerCase: image file names are lower case.Documentation fixes the tests found
InputsWindow_SendText.png→inputs-window-send-text.png. This also fixesinputs-window.md, which referencedinputswindow.pngand only worked on case-insensitive file systems.memory-groups.png(Memory groups),android-logcat-send-unix-signal.png(Terminate an application) andandroid-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.memory-window-capture.png(identical tomemory-window-details-panel.png) andlabel-c.png(no page labels a third area).🤖 Generated with Claude Code