fix: Add help urls to all components in the component menu #3663
Conversation
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
| @@ -1,5 +1,8 @@ | |||
| using System; | |||
| using System.Collections.Generic; | |||
| using Unity.Netcode.Runtime; | |||
| using UnityEditor; | |||
There was a problem hiding this comment.
Standards is complaining that UnityEditor is unnecessary here
|
Really nice idea to add those! The only thing I wonder is if we are somehow able to add a quick test that verifies that a given page/tag exists. For example "advanced-topics/physics.html#networkrigidbody2d" because sometimes I'm encountering this problem with docs in general that maybe the tag networkrigidbody2d will change and thus the link will be invalidated silently Sam did similar thing in https://github.cds.internal.unity3d.com/unity/dots/pull/14283 but it was within the editor so not exactly the same |
NoelStephensUnity
approved these changes
Sep 11, 2025
EmandM
added
port:1.x-completed
EmandM
added a commit
that referenced
this pull request
Sep 16, 2025
## Purpose of this PR Adds help urls to all components that are added to the component menu. This ensures the question mark icon in the inspector view will redirect to a valid page. ### Jira ticket [MTTB-1452](https://jira.unity3d.com/browse/MTTB-1452) ### Changelog - Added: Help URLs ensure the inspector redirects to valid web pages. ## Documentation - No documentation changes or additions were necessary. ## Testing & QA (How your changes can be verified during release Playtest) [//]: # ( This section is REQUIRED and should describe how the changes were tested and how should they be tested when Playtesting for the release. It can range from "edge case covered by unit tests" to "manual testing required and new sample was added". Expectation is that PR creator does some manual testing and provides a summary of it here.) <!-- Add any performance testing results here if relevant. --> ### Functional Testing [//]: # (If checked, List manual tests that have been performed.) _Manual testing :_ - [x] `Manual testing done` _Automated tests:_ - [ ] `Covered by existing automated tests` - [x] `Covered by new automated tests` _Does the change require QA team to:_ - [ ] `Review automated tests`? - [ ] `Execute manual tests`? - [ ] `Provide feedback about the PR`? If any boxes above are checked the QA team will be automatically added as a PR reviewer. ## Backports This is a backport of #3663
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Purpose of this PR
Adds help urls to all components that are added to the component menu. This ensures the question mark icon in the inspector view will redirect to a valid page.
Jira ticket
MTTB-1452
Changelog
Documentation
Testing & QA (How your changes can be verified during release Playtest)
Functional Testing
Manual testing :
Manual testing doneAutomated tests:
Covered by existing automated testsCovered by new automated testsDoes the change require QA team to:
Review automated tests?Execute manual tests?Provide feedback about the PR?If any boxes above are checked the QA team will be automatically added as a PR reviewer.
Backports
Backported by #3676