-
Notifications
You must be signed in to change notification settings - Fork 329
DOCS: Restored missing images from workflow manual pages (DOCATT-9570) #2236
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Restored removed images (see #2185) - Added the image references back to the table on the Workflows landing page - Also replaced makeshift Notes and Tips with DocFx admonitions
Codecov ReportAll modified and coverable lines are covered by tests ✅ @@ Coverage Diff @@
## develop #2236 +/- ##
===========================================
- Coverage 68.14% 68.14% -0.01%
===========================================
Files 367 367
Lines 53685 53685
===========================================
- Hits 36585 36584 -1
- Misses 17100 17101 +1
Flags with carried forward coverage won't be shown. Click here to find out more. see 1 file with indirect coverage changes 🚀 New features to boost your workflow:
|
You need to run formatting (https://unity.slack.com/archives/C04RDRXRJ1L/p1756470893890159 ) And the title is not formatted correctly, it has to start with these categories (mentioned in the checklist): "Commit message for squash-merge is prefixed with one of the list: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, just needs the formatting fixed
Fixed missing images from workflow manual pages, including:
Description
The 3 subtopic Workflow pages are currently displaying broken images icons because those images were removed as part of work during an accessibility sprint (see PR#2185. I decided to restore the images because they are not screen shots, which was the original justification for removing them: they are images that demonstrate workflow.
These workflow images fit in nicely with the introductory images on the Concepts page and so they tie the workflows and concepts together effectively. So I also added the images back to the table on the Input System Workflows page, but made sure that the table is still accessibility compliant.
Testing status & QA
I generated the documentation locally.
Overall Product Risks
Very low risk, since these are fairly minor doc changes.
Comments to reviewers
In PR #2185, the images were removed because the writer was thinking that they were screen shots, which can easily drift out of date. However, these images were conceptual drawings that can make the concepts and workflows more accessible for many readers.
This should be straightforward to review but please reassign to another Input team member if you are unavailable.
Checklist
Before review:
During merge:
FIX: Restored missing images
After merge: