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

OnlineHelp or Local Documentation by F1 + fixes in quick doc link to external doc #2050

Merged
merged 24 commits into from
Mar 26, 2021

Conversation

van800
Copy link
Contributor

@van800 van800 commented Mar 22, 2021

  1. Quick Documentation shortcut opens Unity types and event functions in locally installed documentation or on docs.unity3d.com.
    image
    RIDER-33108 Allow to open Unity local documentation.

Need to test Re# version.

  1. Links in QuickDoc popup:
    Show links to dotnet/mono/unity documentation
    RIDER-55736 Tweak external documentation link for generic methods
    RIDER-39068 Improve QuickDoc API to include external documentation URL
    RIDER-57745 Wrong page opens in external documentation
    RIDER-60297 External Doc link for parameter of event function should go to eventfunction doc instead
    RIDER-55737 Allow customizing QuickDoc link to use localized Unity documentation

@van800 van800 requested a review from citizenmatt March 23, 2021 13:44
@van800 van800 self-assigned this Mar 24, 2021
@van800 van800 changed the title OnlineHelp by F1 + fixes in quick doc link to external doc OnlineHelp or Local Documentation by F1 + fixes in quick doc link to external doc Mar 24, 2021
@van800 van800 added this to the Rider 2021.2 milestone Mar 24, 2021
@van800 van800 requested a review from citizenmatt March 24, 2021 14:39
Copy link
Member

@citizenmatt citizenmatt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

var englishRoot = root.Combine("en");
if (!englishRoot.ExistsDirectory)
return root.GetChildDirectories().FirstOrDefault(englishRoot);
return englishRoot;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wow. Does this mean they're installing non-English documentation now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really. It can be downloaded separately and manually put to the folder
https://docs.unity3d.com/Manual/OfflineDocumentation.html

@van800 van800 merged commit adf7994 into net212 Mar 26, 2021
@van800 van800 deleted the net212-external-doc branch March 26, 2021 06:50
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.

None yet

2 participants