Publish

This guide provides a minimal, reproducible release flow for repository updates and GitBook docs.

1. Validate Locally

npm ci
npm run test
npm run build

If you also want desktop artifacts:

npm run electron:build

2. Update Documentation Source

Source of truth is docs/.

After editing docs, regenerate GitBook copy:

node scripts/copy-docs-for-gitbook.cjs

This updates docs/gitbook/ from docs/.

3. Create Release Branch

git checkout -b release/docs-refresh
git add docs scripts/copy-docs-for-gitbook.cjs
git commit -m "docs: rewrite developer documentation and sync gitbook copy"

4. Push and Open PR

git push origin release/docs-refresh

Recommended PR checks:

• tests pass

• build passes

• docs render correctly in Markdown viewer

• docs/SUMMARY.md links are valid

5. Tag Release (After Merge)

git checkout main
git pull origin main
git tag -a v1.0.9 -m "KatanOS 1.0.9 docs refresh"
git push origin v1.0.9

Adjust tag naming to your project policy.

6. Optional Release Artifacts

For Windows distributions, attach generated files from dist/ (installer/AppX as applicable).

Signing, Store metadata, and publisher identity are managed outside this repository documentation.