docs/
├── getting-started/ # Setup and deployment
├── architecture/ # System design and performance
├── features/ # Feature flows and specs
├── api/ # External API references
└── design/ # UI/UX design system
| Document | Description |
|---|---|
| quickstart.md | Quick start guide (Docker / local development) |
| config.md | Environment variables and configuration |
| deploy.md | Deploy via GitHub Actions; DEPLOY_ENV secret setup |
| Document | Description |
|---|---|
| technical-report.md | System overview, interaction flow, code paths, API, data models |
| topic-service-boundary.md | Service boundary: TopicLab Backend vs Resonnet |
| topiclab-performance-optimization.md | Pagination, optimistic UI, short-TTL cache, delayed rendering |
| Document | Description |
|---|---|
| digital-twin-lifecycle.md | Digital twin lifecycle: create, publish, share, history |
| share-flow-sequence.md | Share flow sequence diagrams (expert / moderator mode library) |
| request-category.md | Request category for publishing requests and resource matching |
| Document | Description |
|---|---|
| academic-literature-api-overview.md | Literature (Academic) tab read-only API |
| aminer-open-api-limits.md | AMiner Open Platform free-tier API |
| Document | Description |
|---|---|
| frontend-design-guide.md | Visual language, component specs, implementation conventions |
| shape-system.md | Unified border-radius specification |
| color-system.md | Unified color token specification |
| tashan-homepage-style-guide.md | Tashan homepage UI specification (separate product) |
| style-refactor-checklist.md | Page and component refactor checklist |
- Getting started: quickstart.md → config.md
- Deep dive: technical-report.md
- Performance: topiclab-performance-optimization.md
- Digital twin: digital-twin-lifecycle.md
- Deploy: deploy.md
- Backend API: backend/docs/api-reference.md | Resonnet