Skip to content

Commit a3c5dde

Browse files
docs: explain the framework's architecture
Add docs/dev/Architecture.md covering: - Repository layout and crate dependency graph - Responsibilities of all 11 crates - Full build pipeline (SSR + SSG + client hydration) - SSR request lifecycle (rendered once at startup via MetaCall) - Dev mode hot-reload flow (two-channel broadcast architecture) - Polyglot API routes (src/api/*.js via MetaCall) - MetaCall integration points - Key data structures (Manifest, SourceDirContainer, PageEntry, RebuildType) Also update docs/README.md to link to the new developer docs section. Closes #19
1 parent c46de48 commit a3c5dde

File tree

2 files changed

+627
-0
lines changed

2 files changed

+627
-0
lines changed

docs/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Welcome to the official documentation for MetaSSR Framework. This guide will hel
55
## Table of Contents
66
- [Table of Contents](#table-of-contents)
77
- [Getting Started](#getting-started)
8+
- [Developer Documentation](#developer-documentation)
89
- [Contributing](#contributing)
910

1011
---
@@ -26,6 +27,14 @@ We welcome contributions from the community! Visit the [Contributing](../CONTRIB
2627
- [Contributing Guide](../CONTRIBUTING.md)
2728
- [Code of Conduct](../CODE_OF_CONDUCT.md)
2829

30+
---
31+
32+
## Developer Documentation
33+
34+
Internal documentation for contributors who want to understand MetaSSR's internals.
35+
36+
- [Architecture](./dev/Architecture.md) — High-level design, crate responsibilities, build pipeline, SSR request lifecycle, hot-reload flow, and MetaCall integration points.
37+
2938

3039
---
3140

0 commit comments

Comments
 (0)