docs: reconcile README/PRD/ROADMAP/ARCHITECTURE/AGENTS with the shipped v0.2.2 state#126
Merged
Conversation
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.
Problem
The audit's most pervasive cross-cutting finding was documentation/version drift — docs that contradict the shipped product, which erodes trust even where the code is correct. Several are copy-paste hazards.
Fixes (each verified against the real code/config)
README.md
docker runexample usedConnectionStrings__WebhookDb; the engine readsConnectionStrings__Default(appsettings.json+ the config table). A reader'sdocker runwould have failed.5128, but the Docker Quick Start (the recommended path) is5100— a Docker user copy-pasting them hit the wrong target. They now use5100(matching Quick Start and the SDK's own default base URL). The "Local Development" section keeps5128(correct fordotnet run).docs/PRD.md — payload transformation removed from the MVP non-goals (it shipped post-MVP via ADR-003); "Last Updated" bumped.
docs/ROADMAP.md — "Latest release" synced from v0.2.0 → v0.2.2 (with the v0.2.1 hardening + portal-package release noted);
@webhookengine/endpoint-manager(B1 Step 7) marked done (portal-v0.1.0, 2026-05-11) instead of "planned". Launch/blog roadmap items left untouched.docs/ARCHITECTURE.md — §2 solution structure now lists the shipped AuditLogs / Portal / DashboardPortal controllers (were omitted); the duplicate
### 3.5heading is fixed (HTTP Delivery Service is now### 3.8, giving a clean 3.1–3.8 sequence).AGENTS.md — frontend stack line corrected from "TypeScript 5.9 + Vite 7" to TypeScript 6 + Vite 8 (matches
src/dashboard/package.json).Notes
.planning/is gitignored (maintainer's local notes) so it isn't part of this PR; it's refreshed separately.<Version>lag (0.2.0 vs the platform line) is intentionally left to release-prep, not changed here.