Validate Setup Guide on Windows

[NethmikaKekuu]

Summary

The current Getting Started documentation has primarily been validated on macOS environment. We need to verify that the setup instructions work correctly on Windows and identify any missing or incorrect steps to setup OpenGIN (core-api, ingestion-api, read-api).

What needs to be done

Please follow the Getting Started guide from a clean Windows environment and note any issues you encounter.

Specifically:

• Follow the installation guide exactly as documented.
• Verify that all commands work in:
  • PowerShell
  • Windows Command Prompt
• Identify any Unix/Linux-specific commands that need Windows equivalents.
• Check whether environment variable setup instructions are correct for Windows.
• Verify that all required dependencies install successfully.
• Confirm that the application starts, functions as expected and pass all tests cases after completing the guide.
• Submit documentation updates for any issues, missing steps, or Windows-specific instructions discovered during testing.

Expected outcome

The Getting Started guide should allow a Windows user to successfully complete the installation without needing to search for additional setup instructions or troubleshoot undocumented issues.

Areas that may need attention

• Environment variable configuration
• Shell-specific command differences
• Dependency installation
• File paths and path separators
• Any platform-specific limitations or workarounds

Deliverables

If you discover any issues while following the guide on Windows, please contribute by:

• Updating the documentation to fix incorrect or missing instructions.
• Adding Windows-specific setup steps where necessary.
• Documenting any platform-specific limitations or required workarounds.
• Confirming in your pull request that you successfully completed the Getting Started guide end-to-end on Windows, or describing where and why the setup failed.

[tomatotomata]

I’m thinking of validating this from the existing Windows checkout path first: follow the Getting Started steps in PowerShell, record the first reproducible platform-specific gaps, and update only the affected setup sections with Windows equivalents. I’ll keep the report evidence-based and note any dependency or runtime blockers instead of guessing at fixes. Let me know what you think.