Skip to content

Windows docs: add a quick start with expected durations, known failures and how to launch #552

Description

@coneilen

Is your feature request related to a problem?
Going from a clean clone to a running Windows app took most of a working session. The information exists, but it's spread across AGENTS.md, graphcode-windows/README.md and Tools/windows/PACKAGING.md. None of them says how long each step takes, what commonly fails, or how to actually launch the result.

Describe the solution you'd like
Add a "Windows quick start" section (in graphcode-windows/README.md, linked from the root README and AGENTS.md) covering:

  • Prerequisites: VS Build Tools and Windows SDK, pwsh 7, winget. Note that the bootstrap installs Swift 6.3.3 via winget, which also installs Python 3.10.
  • Steps with rough durations: bootstrap, Swift staging (the graphcoded build took about 220 s on the reference machine), shell build and packaging.
  • Known failures and fixes:
    • Deep checkout paths hitting MAX_PATH; use a short root such as C:\gc.
    • Git long paths for providers.
    • Slow ziglang.org downloads.
    • package.ps1 requiring a release tag.
  • How to launch a local build: daemon first, then the shell, with GRAPHCODE_SUPPORT_DIR. Mention the first-run onboarding dialog. Note that you should not redirect USERPROFILE.
  • What validation does and doesn't prove, linking to the parity ledger.

Update the section once the quick-start script, local packaging and bootstrap issues land.

Describe alternatives you've considered
None. The doc is cheap and saves new users hours.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationwindowsWindows port

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions