Publishing

Package

Build and inspect the npm package before publishing:

pnpm --dir packages/capture-sdk build
pnpm --dir packages/capture-sdk pack --dry-run

The package has a prepublishOnly script that rebuilds and performs a dry-run pack check. The build also obfuscates dist/index.js after bundling. The dry-run output should include dist/recorder-window.html, dist/audio-helper/windows-loopback-audio.ps1, dist/input-helper/lookloot-input-helper.exe, and scripts/prepare-obs-runtime.mjs.

The npm package intentionally does not include the full OBS Studio portable runtime. Partner Windows installers must prepare OBS with npx lookloot-capture-prepare-obs --out vendor/obs and bundle it separately under Electron resources/obs, or pass obsPath/LOOKLOOT_OBS_PATH for local smoke tests and custom packagers.

Publish when the package contents look right:

pnpm --dir packages/capture-sdk publish --access public

Docs

The docs are GitBook-native. The repository root includes .gitbook.yaml, which points GitBook at the docs/ folder and uses docs/README.md plus docs/SUMMARY.md for the table of contents.

GitBook structure:

docs/
  README.md
  SUMMARY.md
  sdk/
    README.md
    quickstart.md
    configuration.md
    events.md
    security.md
    publishing.md

Before syncing or publishing docs, run:

pnpm docs:check

To review the local LookLoot-styled preview, run:

pnpm docs:preview

The local preview uses the custom renderer in scripts/preview-gitbook-docs.mjs. It does not use HonKit.

To publish with GitBook's standard hosted design, connect the repository with Git Sync in GitBook and select the branch that contains .gitbook.yaml. GitBook will read the docs root from that file. If the import flow asks for a docs root manually, use docs/.

The local browser preview is only for source review. The canonical styled docs experience should be the hosted GitBook space so SDK docs stay on GitBook's standardized layout.