-
Notifications
You must be signed in to change notification settings - Fork 21
Add Desktop Windows .nsis instructions #730
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
base: main
Are you sure you want to change the base?
Conversation
|
Claude finished @neuronull's task in 2m 3s —— View job Code Review Complete
SummaryThis PR adds helpful documentation for Windows .nsis build file requirements. The content is accurate and well-illustrated, but there are a few style guide consistency issues to address. Findings♻️ Missing
🎨 Instructions format
🎨 Unusual "Figure X:" heading pattern
🎨 Image alt text formatting
Positive aspects
Overall: Approve with suggestions for style consistency improvements. |
|
Great job! No new security vulnerabilities introduced in this pull request |
coltonhurst
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks pretty good, thanks for adding this @neuronull!
One general question I'm sure you thought about. Why have this on its own page, versus a small section added under the troubleshooting section? I'm not against it having its own page, but I'm wondering if some things could be made more concise to fit it there?
Another option is keeping the new page and adding the problem to the troubleshooting section with a link to the new page as the solution.
| --- | ||
| sidebar_custom_props: | ||
| access: bitwarden | ||
| --- |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any reason the new page is only visible to Bitwarden developers, instead of both Bitwarden and Community developers? (For readers: to find the page without searching, you have to have "Bitwarden Developer" selected in the top right, unless I'm missing another path.)
| 1. Download the corresponding `.nsis` file from the build artifacts page. | ||
| 2. Place the `.nsis` file in the same folder as the installer. This might require de-compressing the | ||
| download. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Non-blocking thought:
It might be nice to clearly state everything required here, including the .exe download as well as what the final directory state should look like? Just an example:
| 1. Download the corresponding `.nsis` file from the build artifacts page. | |
| 2. Place the `.nsis` file in the same folder as the installer. This might require de-compressing the | |
| download. | |
| 1. Download the standard / beta Windows build (the `.exe` from figure 2) | |
| 2. Download the corresponding `.nsis` file (also seen in figure 2) | |
| 3. Place the `.nsis` file in the same directory as the installer (this might require decompressing the download) | |
| The final directory state before starting the install should look like: | |
| { screenshot or code block with files & extensions listed here } |

🎟️ Tracking
https://bitwarden.atlassian.net/browse/PM-27193
📔 Objective
Add documentation for the requirement to have
.nsisfile adjacent to the installer for Windows builds.⏰ Reminders before review
team
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes