-
Notifications
You must be signed in to change notification settings - Fork 312
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
DOCS: New Timing and Latency section (DOCF-1179) #1994
Conversation
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.
Left some comments. Have you run this markdown through Vale? I think there's probably some minor stuff it would highlight which you might want to fix.
I think in terms of structure it might need tweaking, especially on the pages that have task and conceptual info on.
Also, I'm not sure if it would make sense to use the suggested file naming convention here for these files? https://docs.unity.com/internal/content-ops/en-us/documentation/content-dev/hexadocs/file-naming-conventions (i know it says it's for hexadocs but it's probably relevant everywhere)
Packages/com.unity.inputsystem/Documentation~/TableOfContents.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/TableOfContents.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/TimingAndLatency.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/TimingInputEventsQueue.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/TimingOptimizeForFixedUpdate.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/TimingOptimizeForFixedUpdate.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/TimingOptimizeForFixedUpdate.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/TimingAvoidMissedOrDuplicateEvents.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/TableOfContents.md
Outdated
Show resolved
Hide resolved
… into docf-1179-fixedupdate-vs-update
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.
I spotted a few formatting things. But overall I think the layout and everything works well.
The only other thing that I can think of that's missing from the New way of doing things is that all pages need "Additional resources" links at the end.
Am approving anyway as all this stuff shouldn't be a blocker to landing this.
Packages/com.unity.inputsystem/Documentation~/timing-input-events-queue.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/timing-select-mode.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/timing-select-mode.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/timing-optimize-dynamic-update.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/timing-optimize-dynamic-update.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/timing-mixed-scenarios.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/timing-mixed-scenarios.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/timing-select-mode.md
Outdated
Show resolved
Hide resolved
Packages/com.unity.inputsystem/Documentation~/timing-select-mode.md
Outdated
Show resolved
Hide resolved
…nts-queue.md Co-authored-by: Jo Dawes <[email protected]>
…de.md Co-authored-by: Jo Dawes <[email protected]>
…de.md Co-authored-by: Jo Dawes <[email protected]>
…dynamic-update.md Co-authored-by: Jo Dawes <[email protected]>
…dynamic-update.md Co-authored-by: Jo Dawes <[email protected]>
…narios.md Co-authored-by: Jo Dawes <[email protected]>
…narios.md Co-authored-by: Jo Dawes <[email protected]>
…de.md Co-authored-by: Jo Dawes <[email protected]>
…de.md Co-authored-by: Jo Dawes <[email protected]>
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.
Looks good. Looking forward to having this live on the documentation page
Description
Adds a section to the docs dedicated to timing and latency.
https://jira.unity3d.com/browse/DOCF-1179
Changes made
Pages added, TOC updated.
Testing
Built and checked locally.
Risk
Docs only change. No technical risk.
Checklist
Before review:
Changed
,Fixed
,Added
sections.Area_CanDoX
,Area_CanDoX_EvenIfYIsTheCase
,Area_WhenIDoX_AndYHappens_ThisIsTheResult
.During merge:
NEW: ___
.FIX: ___
.DOCS: ___
.CHANGE: ___
.RELEASE: 1.1.0-preview.3
.After merge: