Skip to content
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

Merged
merged 25 commits into from
Oct 18, 2024

Conversation

duckets
Copy link
Collaborator

@duckets duckets commented Sep 3, 2024

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:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

After merge:

  • Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

@duckets duckets changed the title Docf 1179 fixedupdate vs update DOCS: New Timing & Latency section (DOCF-1179) Sep 4, 2024
@duckets duckets changed the title DOCS: New Timing & Latency section (DOCF-1179) DOCS: New Timing and Latency section (DOCF-1179) Sep 4, 2024
Copy link
Contributor

@jo-unity jo-unity left a 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)

@duckets duckets marked this pull request as ready for review September 27, 2024 10:46
Copy link
Contributor

@jo-unity jo-unity left a 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.

Copy link
Collaborator

@lyndon-unity lyndon-unity left a 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

@AlexTyrer AlexTyrer merged commit 94c260e into develop Oct 18, 2024
77 checks passed
@AlexTyrer AlexTyrer deleted the docf-1179-fixedupdate-vs-update branch October 18, 2024 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants