docs: improve README and add comprehensive internal documentation #686
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
- Reposition Deepkit as "the unified high-performance TypeScript stack" - Emphasize integrated libraries that work together without glue code - Add sections on zero-decorator DI, type-first ORM, binary RPC - Highlight suitability for AI-assisted development - Remove specific benchmark numbers pending updated measurements Add internal documentation: - CLAUDE.md: AI assistant guidance for the codebase - ARCHITECTURE.md: Technical architecture and data flows - BENCHMARKS.md: Benchmark framework and methodology - CONTRIBUTING.md: Development workflow and standards - PACKAGES.md: Package reference guide - QUALITY.md: QA processes and edge cases - ROADMAP.md: Project priorities and planning - TESTING.md: Test strategy and coverage - VISION.md: Project goals and competitive landscape
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
Repositions Deepkit as "the unified high-performance TypeScript stack" — emphasizing that it's not just about runtime types, but a complete integrated stack where libraries work together without glue code.
README Changes
New Internal Documentation
CLAUDE.mddocs/ARCHITECTURE.mddocs/BENCHMARKS.mddocs/CONTRIBUTING.mddocs/PACKAGES.mddocs/QUALITY.mddocs/ROADMAP.mddocs/TESTING.mddocs/VISION.md