docs: architecture internals + root README refresh - #44
Merged
Conversation
Add an 'Internal @exortek/shared layer' section covering the store-primitive family factories (record-store, registry-store, incr-store, custom-store, redis-helpers) that stateful packages compose, and the rules around the private never-published shared package. Update the JSDoc→.d.ts note to reflect the rollup-plugin-dts declaration-bundling pass that inlines shared's types so shipped declarations stay self-contained.
- Consolidate the two overlapping package tables (Shipping + The stack) into a single dependency-ordered table with npm version badge + one-line summary. - Replace the 18-line per-package `npm install` list with one generic example plus a compact optional-peers table (Redis / Express·Fastify / argon2·bcrypt). - Unify the badge set to a consistent flat-square style with logos; add types + dependency badges. - Tighten the intro and section order (Why → example → install → packages).
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.
Documentation-only. Two related docs improvements.
1.
ARCHITECTURE.md— internal shared layerNew "Internal
@exortek/sharedlayer" section documenting, for contributors:record-store,registry-store,incr-store,custom-store,redis-helpers) that stateful packages compose instead of re-writing memory/Redis/dialect plumbing.sharedpackage..d.tsdeclaration-bundling pass (rollup-plugin-dts) that inlinesshared's types so shipped declarations stay self-contained — and the updated JSDoc→.d.tsnote to match.2. Root
README.mdrefreshnpm installlist is replaced by one generic example + a compact optional-peers table (Redis · Express/Fastify · argon2/bcrypt).flat-squarestyle with logos, plustypes includedanddeps: node:cryptobadges.No package files touched — no changeset needed.