[docs] Updated quick-start docs for gsoc25 features #347
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
nemesifier
reviewed
Sep 23, 2025
docs/user/quickstart.rst
Outdated
| Right now, the update of the upgrade information is not asynchronous yet, | ||
| so you will have to reload the page periodically to find new information. | ||
| This will be addressed in a future release. | ||
| The firmware upgrade process now features a realtime progress bar that |
There was a problem hiding this comment.
I would try to communicate this with less words and connect it to the previous sentence, eg:
then a new tab "<NAME OF TAB HERE>" will appear in the device page which allows us to
observe in real time what's going on during the upgrade without requiring page reloads.
<SCREENSHOT OR GIF FOCUSED ON THIS ASPECT HERE>
Adding another dedicated screenshot should help to give more visibility to this great work you've done.
docs/user/quickstart.rst
Outdated
| Right now, the update of the upgrade information is not asynchronous yet, | ||
| so you will have to reload the page periodically to find new information. | ||
| This will be addressed in a future release. | ||
| The mass upgrade operation now features a realtime progress bar that |
There was a problem hiding this comment.
I would try to communicate this with less words and connect it to the previous sentence, eg:
you will be redirected to a page in which you can monitor the progress of the upgrade operations
in real time.
<SCREENSHOT OR GIF FOCUSED ON THIS ASPECT HERE>
Adding another dedicated screenshot should help to give more visibility to this great work you've done.
nemesifier
reviewed
Oct 7, 2025
There was a problem hiding this comment.
Here we need to change the path of 2 existing gifs to point to docs/images/26/[etc] as explained here:
#348 (review)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Checklist
Reference to Existing Issue
Closes #346