docs(architecture): add "the problem this exists to solve" section#16
Merged
Merged
Conversation
…page The architecture doc was jumping straight from a one-paragraph intro to the module graph. A reader landing on nest-native.dev/reference-app/ architecture.html needs the "why should I care, what does this save me from figuring out" framing first — otherwise the architecture content reads as design-by-example with no clear question being answered. New section sits between the intro and the module graph. It frames the app as a commitment to specific answers for the 5 composition questions an adopter would otherwise have to design from scratch: threading current-user/org through the stack, transactions across services (including the better-sqlite3 trap), post-commit side effects, keeping the typed-client contract honest, and the boring CI/test/build scaffolding. Each bullet links to the relevant deeper section in this same doc, so the new content acts as both a "why" and a TOC.
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.
Summary
The architecture page at
nest-native.dev/reference-app/architecture.htmlwas jumping straight from a one-paragraph intro to the module graph. A reader landing there needs the "why should I care, what does this save me from figuring out" framing first — otherwise the architecture content reads as design-by-example with no clear question being answered.This PR adds a single new H2 section between the intro and the module graph. Each bullet links to the relevant deeper section in this same doc, so the new content doubles as a TOC.
Changes
docs/architecture.md— new## The problem this exists to solvesection. Frames the app as a commitment to specific answers for the 5 composition questions an adopter would otherwise have to design from scratch:currentUser/currentOrganizationthrough middleware → tRPCcreateContext→ guards → request-scoped DI@InjectTransaction(), including thebetter-sqlite3async-adapter trapclient-smokein CIModules Touched
Public Surface (libraries)
Security Review
Dependency Review
Migrations
Validation
npm run ciunaffected (docs only).#request-lifecycle,#authentication,#why-a-custom-syncdrizzletransactionaladapter,#outbox,#the-worker-process) all map to existing H2/H3 headings in the same doc and will be auto-generated by Jekyll.Release Notes
nest-native.dev/reference-app/architecture.html.