Skip to content

Conversation

@lachlan-robinson
Copy link
Contributor

Description

This PR adds a Windows-specific setup guide for the 8.x and 9.x branches. It documents the steps required to resolve environment issues when switching branches, including closing the dev container, deleting package-lock.json, removing old Docker containers and volumes, updating dependencies and scripts in package.json, and restarting the development container. The guide ensures a smooth setup process for Windows users working with these branches.

Type of change

  • Documentation (update or new)

How Has This Been Tested?

  • Has been tested in Chrome and Firefox to ensure Astro builds with changes.
  • Has been tested in light and dark mode to confirm image visibility.

Testing Checklist

  • Tested in latest Chrome
  • Tested in latest Safari
  • Tested in latest Firefox

Checklist

  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

@netlify
Copy link

netlify bot commented Aug 3, 2025

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit ae699ee
🔍 Latest deploy log https://app.netlify.com/projects/ontrackdocumentation/deploys/688f47dd2ec1c1000800c74e
😎 Deploy Preview https://deploy-preview-44--ontrackdocumentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@returnMarcco
Copy link

Hi @lachlan-robinson,

I'll be reviewing this PR as a senior.

All in all, the documentation accurately details the steps required to properly enable branch switching to configure the development environment for Windows based machines. I can offer the following feedback, albeit being a little nit picky:

  1. The section that mentions deleting package-lock.json says to go into the doubtfire-deploy directory. Whilst this is technically correct, it may be more straightforward to mention navigating into the doubtfire-web directory to find this file.
  2. Stipulating what the ng-serve poll command is for may help readers understand what it is they are fixing.
  3. Stipulating the actual problem these instructions aim to solve will help readers understand why they are following these instructions.

I'll approve this PR and let you consider the feedback above.

Well done, keep it up.

Copy link
Contributor

@ibi420 ibi420 left a comment

Choose a reason for hiding this comment

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

Hello Lachlan, your documentation clearly covers the required steps for building on both 8.x and 9.x, with appropriate visual aids. You’ve also modified the repository correctly. Thank you for the opportunity to review your work.

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.

3 participants