Skip to content

Comments

Address PR review feedback and lint VPN documentation#312

Merged
CarlosLopezElorduy merged 3 commits into293-vpn-setup-irbcluster02from
copilot/sub-pr-304
Jan 23, 2026
Merged

Address PR review feedback and lint VPN documentation#312
CarlosLopezElorduy merged 3 commits into293-vpn-setup-irbcluster02from
copilot/sub-pr-304

Conversation

Copy link
Contributor

Copilot AI commented Jan 23, 2026

Addressed 9 review comments on the VPN setup documentation, fixing clarity issues, adding security warnings, and ensuring markdown compliance.

Structural improvements:

  • Added explicit installation step (step 3) between download and DNS configuration
  • Reorganized steps so FortiClient installation precedes configuration file download
  • Fixed image path from assets/ to ../assets/images/ for correct relative resolution

Security and warnings:

  • Added warning box for DNS configuration explaining permanent system-wide changes with revert command
  • Added security notice for "Save login" feature, advising use only on trusted, non-shared computers

Clarity enhancements:

  • Specified UI element locations: "three-bar menu icon (usually in the top-right corner)"
  • Clarified interface components: "XML tab", "+ Import XML Configuration button"
  • Improved phrasing: "Click the three-bar menu icon again" (was "Hit again the three bars")
  • Corrected vocabulary: "enter your password" (was "introduce your password")

Linting:

  • Fixed MD013 line-length violations (120 character limit)
  • All markdownlint-cli2 checks now pass

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits January 23, 2026 14:07
Co-authored-by: CarlosLopezElorduy <107858804+CarlosLopezElorduy@users.noreply.github.com>
Co-authored-by: CarlosLopezElorduy <107858804+CarlosLopezElorduy@users.noreply.github.com>
Copilot AI changed the title [WIP] Update VPN setup instructions and add image Address PR review feedback and lint VPN documentation Jan 23, 2026
@CarlosLopezElorduy CarlosLopezElorduy marked this pull request as ready for review January 23, 2026 14:24
@CarlosLopezElorduy CarlosLopezElorduy merged commit 822b42d into 293-vpn-setup-irbcluster02 Jan 23, 2026
1 check passed
@CarlosLopezElorduy CarlosLopezElorduy deleted the copilot/sub-pr-304 branch January 23, 2026 14:26
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.

2 participants