chore: align docs to reality, add build to CI, fix the broken prod build - #11
Merged
Merged
Conversation
The repo advertised more than the code shipped, and the gateway production build was silently broken (CI never ran it). This is the first slice of a planned series that closes the gap between the docs and the code. What changed - Fix: `tsconfig.build.json` no longer globs the dashboard's `.ts` sources into the Node build (they failed on extensionless imports — `pnpm build` exited 2 on `main`). Build is green again, and `pnpm build` is now part of the CI `verify` job so it can't silently regress. - Reconcile `package.json` versions `0.0.0` → `0.1.0` (root + both workspaces) to match the published release; drop the stale "Scaffold" gateway description. - Doc-accuracy pass: k6 → Node load harness (`load/run.ts`); v1.0 → v0.1.0; single-node in-memory cache + SQLite (Redis/Postgres described as documented future swaps behind existing interfaces); dashboard marked shipped; providers described as OpenAI-compatible (native Anthropic noted as planned); honest benchmark caveats; new README "Known limitations" section. Why - A post-v0.1.0 audit found doc/code drift and a red-but-unrun production build. How to verify - `pnpm verify` → green (typecheck + lint + 90% coverage) - `pnpm build` → green (was exit 2 on `main`) - `npx prettier --check CHANGELOG.md` → clean No runtime behavior change. Assumptions - Redis & Postgres are downscoped to docs (v1 is single-node per PRP_SPEC §3/§6), not built. Cost tracking and a native Anthropic adapter land in follow-up PRs.
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
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.
The repo advertised more than the code shipped, and the gateway production
build was silently broken (CI never ran it). This is the first slice of a
planned series that closes the gap between the docs and the code.
What changed
tsconfig.build.jsonno longer globs the dashboard's.tssourcesinto the Node build (they failed on extensionless imports —
pnpm buildexited 2 on
main). Build is green again, andpnpm buildis now part ofthe CI
verifyjob so it can't silently regress.package.jsonversions0.0.0→0.1.0(root + both workspaces)to match the published release; drop the stale "Scaffold" gateway description.
load/run.ts); v1.0 → v0.1.0;single-node in-memory cache + SQLite (Redis/Postgres described as documented
future swaps behind existing interfaces); dashboard marked shipped; providers
described as OpenAI-compatible (native Anthropic noted as planned); honest
benchmark caveats; new README "Known limitations" section.
Why
How to verify
pnpm verify→ green (typecheck + lint + 90% coverage)pnpm build→ green (was exit 2 onmain)npx prettier --check CHANGELOG.md→ cleanNo runtime behavior change.
Assumptions
not built. Cost tracking and a native Anthropic adapter land in follow-up PRs.