docs(khal-os): patterns + dev + release + reference — 7 pages#7
Merged
Conversation
- patterns/frontend-only-pack.mdx — pack-settings canonical pattern - patterns/full-stack-pack.mdx — pack-terminal PTY+NATS canonical pattern - dev/local-dev-and-testing.mdx — unified build/test/debug loop - release/publish-your-pack.mdx — CI-driven npm + Docker + Helm flow - release/customer-install.mdx — thin handoff contract for customer admins - reference/khal-app-json-schema.mdx — manifest field reference (derived from @khal-os/types) - reference/example-packs.mdx — matrix of reference pack repos Kernel-protection guardrails applied throughout: no core/platform/brain/deploy internals, contracts exposed over mechanisms, NATS surface only. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…n frontend-only-pack
Review flagged (report at genie-docs/reports/pr-review-2026-04-17.md):
- useKhalConfig() does not exist in app-kit/packages/os-sdk — removed.
- useKhalAuth() returns {userId, orgId, role, permissions, loading}, not {user, signOut}.
- Realigned code example with actual KhalAuth interface from app-kit/packages/types/src/auth.ts.
- Noted explicitly that sign-out is a shell concern, matching sdk/useKhalAuth.mdx.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Completes the FDE-manual ship side: reference patterns, the unified dev loop, the publish pipeline, the customer-install handoff, and the canonical reference pages.
Pages added
Patterns (the two canonical pack shapes)
patterns/frontend-only-pack.mdx— pack-settings as the reference; no service, no Helm, just an npm package.patterns/full-stack-pack.mdx— pack-terminal as the reference; NATS-bridged frontend ↔ Bun service.Dev loop
dev/local-dev-and-testing.mdx— build + watch + typecheck + test + debug, in one page (collapsed from 10 candidate pages per council verdict).Release
release/publish-your-pack.mdx— the PR → merge → CI → publish flow, grounded in pack-template's actual workflows (ci.yml, ci-guards.yml, release.yml).release/customer-install.mdx— intentionally thin. What the FDE hands off to the customer admin, and what is explicitly NOT the FDE's problem.Reference
reference/khal-app-json-schema.mdx— manifest field reference derived fromapp-kit/packages/types/src/manifest.ts.reference/example-packs.mdx— matrix of reference packs with what-to-learn mapping.Authoring note
This PR was authored by hand after the
docs-khal-shipteam-lead did not ship a PR overnight. The wish at.genie/wishes/docs-khal-ship/WISH.mdis the source spec; this PR closes that wish.Kernel-protection guardrails (applied)
core/,platform/,brain/,deploy/source citations.customer-installis deliberately thin.Sibling PRs (same sprint)
Together: 20-page FDE manual, nav wired, starter-kit gone.
Generated with Claude Code.