Skip to content

Fix macOS/Linux sidecar build script and desktop setup docs#25

Open
adilzubair wants to merge 1 commit into
vasu-devs:mainfrom
adilzubair:fix-sidecar-build-docs
Open

Fix macOS/Linux sidecar build script and desktop setup docs#25
adilzubair wants to merge 1 commit into
vasu-devs:mainfrom
adilzubair:fix-sidecar-build-docs

Conversation

@adilzubair

Copy link
Copy Markdown

Summary

Fix the macOS/Linux sidecar build flow and update the desktop contributor setup docs to match the actual required steps.

This change fixes scripts/build-sidecar.sh so it produces the resource layout Tauri expects, uses repo-local cache directories during the sidecar build, and fails clearly if the expected sidecar binary is missing.

It also updates README.md and CONTRIBUTING.md so first-time contributors know they need to build the packaged sidecar resource before running npm run tauri dev.

Type of Change

  • Scraper/source adapter
  • Ranking/scoring
  • Vector/profile intelligence
  • Customizer/document generation
  • Frontend/UI
  • Backend/API/storage
  • Docs/OSS hygiene
  • CI/release
  • Experimental automation

Testing

Commands run:

  • npm run typecheck
  • npm test
  • npm run build
  • backend/.venv/Scripts/python.exe -m pytest backend/tests
  • cd src-tauri && cargo check
  • Other:
    • bash scripts/build-sidecar.sh

Privacy And Safety

  • No API keys, cookies, bearer tokens, resumes, local databases, or generated private documents are included.
  • User-facing behavior is clear about what is core vs experimental.
  • Ranking/filtering changes include explanations or tests where relevant.

Notes For Reviewers

This is a focused contributor-experience fix.

The main behavior change is in the macOS/Linux Bash sidecar helper, which now mirrors the working PowerShell flow more closely. The doc updates are intentionally small and only cover the missing step needed for full desktop setup.

@vercel

vercel Bot commented May 7, 2026

Copy link
Copy Markdown

@adilzubair is attempting to deploy a commit to the Vasu-Devs' projects Team on Vercel.

A member of the Team first needs to authorize it.

@adilzubair

Copy link
Copy Markdown
Author

This overlaps with the existing PR that fixes the incorrect PyInstaller --distpath.

This PR also includes a few follow-up improvements:

  • contributor docs for the missing sidecar build step
  • repo-local cache env vars for the sidecar build
  • a clearer failure check if the expected sidecar binary is not created

If maintainers prefer, I’m happy to narrow this PR to the non-overlapping follow-up changes only.

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.

1 participant