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: Improves DOCF-5483. #2095

Merged
merged 2 commits into from
Dec 19, 2024
Merged

DOCS: Improves DOCF-5483. #2095

merged 2 commits into from
Dec 19, 2024

Conversation

benoitalain
Copy link
Collaborator

Description

Adds a link in Input System's "UI Support" documentation to the UI Toolkit manual page that contains more explanations on input handling. This should end up effectively addressing the problem of lack of clarity and scarcity of information mentioned in the DOCF-5483 jira task.

Testing status & QA

No testing. This is documentation only. That being said, I'll defer to Ben Pitt to verify that the documentation changes are showing properly.

Overall Product Risks

  • Complexity: minimal
  • Halo Effect: minimal

Comments to reviewers

Documentation only. No new entry, just a small improvement on an existing manual page. Do I need to add an entry to the changelog?

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.

@benoitalain benoitalain requested a review from duckets December 18, 2024 20:09
@benoitalain benoitalain changed the title Improves DOCF-5483. DOCS: Improves DOCF-5483. Dec 18, 2024
@benoitalain
Copy link
Collaborator Author

@duckets I landed another PR on trunk for the UI Toolkit side of this documentation: https://github.cds.internal.unity3d.com/unity/unity/pull/58531

However, that will only show up in the 6000.1 documentation (and it doesn't show up yet as of today even though it landed a few hours ago). I guess until trunk's documentation 1) is updated and 2) points to 6000.1 by default, the DOCF-5483 task can't be fully completed. But those two things should happen by themselves without anything more from us, so I'll try to land this either way,

@benoitalain benoitalain merged commit 2d824e1 into develop Dec 19, 2024
69 of 77 checks passed
@benoitalain benoitalain deleted the docf-5483 branch December 19, 2024 17:13
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.

2 participants