ksw/change in-app help to readthedocs user manual #2438
Conversation
This file contains 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
YuHsuan-Hwang
approved these changes
Nov 29, 2024
There was a problem hiding this comment.
Overall the changes look good. 👍
It might become more responsive if we can implement a loading icon before the website is loaded, but we can consider this in a separate PR.
Also, I suggest we adjust the manual website to opening new tabs when clicking all external website links.
YuHsuan-Hwang
added
awaiting code review
YuHsuan-Hwang
removed
awaiting code review
YuHsuan-Hwang
added
the
awaiting merge
|
Ready for merge when the urls are finalized. |
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.
Description
Close #2241.
This PR tries to remove the in-app help context from the codebase and switch to the online readthedocs user manual. The URLs in
HelpDrawerComponent.tsxare not finalized at this stage as the readthedocs user manual requires a major reorganization of topics to fit the scene. This will be handled right after v5-beta release is out.Checklist
For linked issues (if there are):
For the pull request:
no changelog update neededunit test added (for functions with no dependenies)API documentation added (for public variables and methods in stores)For dependencies:
protobuf version bumped/ no protobuf version bumped neededprotobuf updated to the latest dev commit/ no protobuf update neededcorresponding ICD test fix added (/ no ICD test fix needed (BackendServicechanged)BackendServiceunchanged)user manual prepared (for large new features)