Bring the docs deploy script up to date on the release branch - #2635
Merged
Conversation
Takes master's deploy_docs.sh so the 6.8 docs can be published from this branch: it no longer checks out gh-pages (which nbstripout leaves permanently dirty), and it titles the version holding the "latest" alias "<version> (latest)".
akenmorris
added a commit
that referenced
this pull request
Aug 25, 2026
* Set version to 6.8.0-RC1 on the release branch Start the 6.8.0 release from a release branch instead of bumping master. master now keeps its -dev version string permanently, so there is no post-release bump back. Update the release process doc to match, and fix the release notes filename it referenced. * Write 6.8.0 release notes and docs Fill in the 6.8.0 release notes from the 93 commits since v6.7.0, grouped as back-end / front-end / documentation / fixes / platform. Point the home page at the 6.8 banner and tour video, and document the new correspondence-quality command and its Python API in the analyze workflow page. The CLI reference in ShapeWorksCommands.md is generated at deploy time and picks up the new command on its own. * Cite the bundled-Python issues in the 6.8.0 release notes * Lead the 6.8 tour tagline with the large-cohort speedups * Document the 6.8 Studio features and optimize parameters No Studio doc was updated during the 6.8 cycle, leaving the new viewer and analysis features undocumented. Adds coverage for the bounding box, scale bar, axis-aligned Views dropdown, shape-relative glyph sizing, Export All Meshes, the Regression tab, and editing cutting-plane centers and normals from the constraints table. Also documents early stopping, whose eight parameters had no coverage since it shipped in 6.7, and geodesic_remesh_percent, whose meaning changed in 6.8. * Studio: antialias the 3D viewers with FXAA Lines rendered in the viewers are aliased -- most visibly the new bounding box, but it applies to cutting planes, contours and mesh silhouettes too. The obvious fix, multisampling, is not available: the surface format sets samples to 0 on purpose because MSAA breaks the depth reads used for pick position (c971ffa). FXAA runs as a post-process pass instead, so it smooths edges without touching the depth buffer and picking is unaffected. Enabled on the lightbox renderer and on each per-viewer renderer. Exported screenshots pick it up as well, since export_to_pixmap() reuses these same renderers in its offscreen window. * Studio: click the status message to clear it The status bar holds the last log message indefinitely, so a file path or debug line stays on screen long after it is useful. That is awkward when capturing screenshots for the documentation, which then leak local paths. Clicking the message now clears it, along with the severity icon that was set with it. The log window keeps the history. The message is left untouched otherwise, so a completion notice from a long optimization is still there when you come back to it. * Set version to 6.8.0 for release * Note that the whole release branch merges back, not just docs * Studio: widen the bounding box lines At 1.5 the edges are thin enough that FXAA treats them as a subpixel feature and blends them toward the background unevenly along their length, so the box reads as dashed. Widening to 2.5 gives the edge enough coverage to survive the blend. * Studio: keep the scale bar labels clear of the shape Closest-triad mode puts the rulers on the box corner nearest the camera, which is in front of the geometry, so the labels are drawn across the shape and appear to jump sides as the nearest corner changes while orbiting. Outer edges keeps them on the silhouette of the box instead, where they are neither over the shape nor hidden behind it. * Update the 6.8 Studio screenshots Retake the three shots that predated features they are meant to show: the viewer controls (2022, no Views button), the export menu (missing Export All Meshes) and the Analyze view panel (missing the Regression tab). Add the bounding box and scale bar capture and reference it from the viewer docs. * Add the Views dropdown screenshot to the viewer docs * Add the Regression tab screenshot to the analyze docs * Add the correspondence quality distance field image * Update light-the-torch to 0.8.1 * Add the 6.8 release banner image * Update banner image * Document updating version.json in the release process Studio's update checker reads version.json from the web server, so until it is updated no existing installation learns about the release. It was not in the process doc, and the live copy still reports 6.6.1. * Set version to 6.8.0_RC1 for release-candidate testing * Update release notes * Fix clipped regression hint message in the Analysis panel * Bring the docs deploy script up to date on the release branch (#2635) * Update release notes * Fix clipped regression hint message in the Analysis panel * Bring the docs deploy script up to date on the release branch Takes master's deploy_docs.sh so the 6.8 docs can be published from this branch: it no longer checks out gh-pages (which nbstripout leaves permanently dirty), and it titles the version holding the "latest" alias "<version> (latest)".
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.
The 6.8 docs published on the site are the hand-made snapshot from
d177336f33, taken before the release notes were expanded — they still show only the Bundled Python section and no release image. Publishing the real ones has to happen from this branch so the API reference andShapeWorksCommands.mdcome from 6.8 binaries.Takes master's
deploy_docs.sh: it no longer checks outgh-pages(which nbstripout leaves permanently dirty), and it titles the version holding thelatestalias<version> (latest). Once merged, run Mac Arm64 Build on this branch withdeploy_docschecked anddocs_aliasblank.