Task-oriented How-To Guides (in-app + GitHub docs); release v1.8.34#103
Merged
Conversation
The in-app User Guide gains a 'How-To Guides' tab: a clickable A–I index of step-by-step recipes for the things users actually do — map & render, set up a watch folder, auto-assemble previz from a filename convention, route setups to scenes, batch-render, auto-deliver, submit to Deadline, save presets, and a 'clips aren't picked up' troubleshooter — each with numbered steps and the relevant screenshots. In-page anchor links scroll within the tab. docs/user-guide.md mirrors the same recipes for GitHub. README already links it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01F3rfxvrhYUyjTsifsuJw9s
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
2 participants
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.
Adds task-oriented help — the thing users asked for after v1.8.33 shipped: not "here's what each panel does" but "here's how to actually do X".
In-app: new "How-To Guides" tab
A clickable A–I index of step-by-step recipes in Help → User Guide, each with numbered steps, screenshots, and links into the relevant settings:
In-page anchor links scroll within the tab (handled in
_on_help_anchor, which now receives the browser).GitHub:
docs/user-guide.mdMirrors the same recipes as a How-to recipes section so the guidance is identical in-app and on GitHub.
Release
Bumps to v1.8.34 so the new in-app help ships (v1.8.33 is already live, signed + notarized). On merge I'll trigger the signed release build.
Verification: ruff clean · mypy clean over 83 files · smoke suite green · How-To tab verified rendering offscreen with all 9 anchors + images resolving.
🤖 Generated with Claude Code
https://claude.ai/code/session_01F3rfxvrhYUyjTsifsuJw9s
Generated by Claude Code