create-fluxstack 1.10.1 → 1.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (257) hide show
  1. package/.dockerignore +1 -2
  2. package/Dockerfile +8 -8
  3. package/LLMD/INDEX.md +64 -0
  4. package/LLMD/MAINTENANCE.md +197 -0
  5. package/LLMD/MIGRATION.md +156 -0
  6. package/LLMD/config/.gitkeep +1 -0
  7. package/LLMD/config/declarative-system.md +268 -0
  8. package/LLMD/config/environment-vars.md +327 -0
  9. package/LLMD/config/runtime-reload.md +401 -0
  10. package/LLMD/core/.gitkeep +1 -0
  11. package/LLMD/core/build-system.md +599 -0
  12. package/LLMD/core/framework-lifecycle.md +229 -0
  13. package/LLMD/core/plugin-system.md +451 -0
  14. package/LLMD/patterns/.gitkeep +1 -0
  15. package/LLMD/patterns/anti-patterns.md +297 -0
  16. package/LLMD/patterns/project-structure.md +264 -0
  17. package/LLMD/patterns/type-safety.md +440 -0
  18. package/LLMD/reference/.gitkeep +1 -0
  19. package/LLMD/reference/cli-commands.md +250 -0
  20. package/LLMD/reference/plugin-hooks.md +357 -0
  21. package/LLMD/reference/routing.md +39 -0
  22. package/LLMD/reference/troubleshooting.md +364 -0
  23. package/LLMD/resources/.gitkeep +1 -0
  24. package/LLMD/resources/controllers.md +465 -0
  25. package/LLMD/resources/live-components.md +703 -0
  26. package/LLMD/resources/live-rooms.md +482 -0
  27. package/LLMD/resources/live-upload.md +130 -0
  28. package/LLMD/resources/plugins-external.md +617 -0
  29. package/LLMD/resources/routes-eden.md +254 -0
  30. package/README.md +37 -17
  31. package/app/client/index.html +0 -1
  32. package/app/client/src/App.tsx +107 -150
  33. package/app/client/src/components/AppLayout.tsx +68 -0
  34. package/app/client/src/components/BackButton.tsx +13 -0
  35. package/app/client/src/components/DemoPage.tsx +20 -0
  36. package/app/client/src/components/LiveUploadWidget.tsx +204 -0
  37. package/app/client/src/lib/eden-api.ts +85 -60
  38. package/app/client/src/live/ChatDemo.tsx +107 -0
  39. package/app/client/src/live/CounterDemo.tsx +206 -0
  40. package/app/client/src/live/FormDemo.tsx +119 -0
  41. package/app/client/src/live/RoomChatDemo.tsx +242 -0
  42. package/app/client/src/live/UploadDemo.tsx +21 -0
  43. package/app/client/src/main.tsx +4 -1
  44. package/app/client/src/pages/ApiTestPage.tsx +108 -0
  45. package/app/client/src/pages/HomePage.tsx +76 -0
  46. package/app/server/app.ts +1 -4
  47. package/app/server/controllers/users.controller.ts +36 -44
  48. package/app/server/index.ts +25 -35
  49. package/app/server/live/LiveChat.ts +77 -0
  50. package/app/server/live/LiveCounter.ts +67 -0
  51. package/app/server/live/LiveForm.ts +63 -0
  52. package/app/server/live/LiveLocalCounter.ts +32 -0
  53. package/app/server/live/LiveRoomChat.ts +285 -0
  54. package/app/server/live/LiveUpload.ts +81 -0
  55. package/app/server/routes/index.ts +3 -1
  56. package/app/server/routes/room.routes.ts +117 -0
  57. package/app/server/routes/users.routes.ts +35 -27
  58. package/app/shared/types/index.ts +14 -2
  59. package/config/app.config.ts +2 -62
  60. package/config/client.config.ts +2 -95
  61. package/config/database.config.ts +2 -99
  62. package/config/fluxstack.config.ts +25 -45
  63. package/config/index.ts +57 -38
  64. package/config/monitoring.config.ts +2 -114
  65. package/config/plugins.config.ts +2 -80
  66. package/config/server.config.ts +2 -68
  67. package/config/services.config.ts +2 -130
  68. package/config/system/app.config.ts +29 -0
  69. package/config/system/build.config.ts +49 -0
  70. package/config/system/client.config.ts +68 -0
  71. package/config/system/database.config.ts +17 -0
  72. package/config/system/fluxstack.config.ts +114 -0
  73. package/config/{logger.config.ts → system/logger.config.ts} +3 -1
  74. package/config/system/monitoring.config.ts +114 -0
  75. package/config/system/plugins.config.ts +84 -0
  76. package/config/{runtime.config.ts → system/runtime.config.ts} +1 -1
  77. package/config/system/server.config.ts +68 -0
  78. package/config/system/services.config.ts +46 -0
  79. package/config/{system.config.ts → system/system.config.ts} +1 -1
  80. package/core/build/flux-plugins-generator.ts +325 -325
  81. package/core/build/index.ts +39 -27
  82. package/core/build/live-components-generator.ts +3 -3
  83. package/core/build/optimizer.ts +235 -235
  84. package/core/cli/command-registry.ts +6 -4
  85. package/core/cli/commands/build.ts +79 -0
  86. package/core/cli/commands/create.ts +54 -0
  87. package/core/cli/commands/dev.ts +101 -0
  88. package/core/cli/commands/help.ts +34 -0
  89. package/core/cli/commands/index.ts +34 -0
  90. package/core/cli/commands/make-plugin.ts +90 -0
  91. package/core/cli/commands/plugin-add.ts +197 -0
  92. package/core/cli/commands/plugin-deps.ts +2 -2
  93. package/core/cli/commands/plugin-list.ts +208 -0
  94. package/core/cli/commands/plugin-remove.ts +170 -0
  95. package/core/cli/generators/component.ts +769 -769
  96. package/core/cli/generators/controller.ts +1 -1
  97. package/core/cli/generators/index.ts +146 -146
  98. package/core/cli/generators/interactive.ts +227 -227
  99. package/core/cli/generators/plugin.ts +2 -2
  100. package/core/cli/generators/prompts.ts +82 -82
  101. package/core/cli/generators/route.ts +6 -6
  102. package/core/cli/generators/service.ts +2 -2
  103. package/core/cli/generators/template-engine.ts +4 -3
  104. package/core/cli/generators/types.ts +2 -2
  105. package/core/cli/generators/utils.ts +191 -191
  106. package/core/cli/index.ts +115 -686
  107. package/core/cli/plugin-discovery.ts +2 -2
  108. package/core/client/LiveComponentsProvider.tsx +60 -8
  109. package/core/client/api/eden.ts +183 -0
  110. package/core/client/api/index.ts +11 -0
  111. package/core/client/components/Live.tsx +104 -0
  112. package/core/client/fluxstack.ts +1 -9
  113. package/core/client/hooks/AdaptiveChunkSizer.ts +215 -215
  114. package/core/client/hooks/state-validator.ts +1 -1
  115. package/core/client/hooks/useAuth.ts +48 -48
  116. package/core/client/hooks/useChunkedUpload.ts +85 -35
  117. package/core/client/hooks/useLiveChunkedUpload.ts +87 -0
  118. package/core/client/hooks/useLiveComponent.ts +800 -0
  119. package/core/client/hooks/useLiveUpload.ts +71 -0
  120. package/core/client/hooks/useRoom.ts +409 -0
  121. package/core/client/hooks/useRoomProxy.ts +382 -0
  122. package/core/client/index.ts +17 -68
  123. package/core/client/standalone-entry.ts +8 -0
  124. package/core/client/standalone.ts +74 -53
  125. package/core/client/state/createStore.ts +192 -192
  126. package/core/client/state/index.ts +14 -14
  127. package/core/config/index.ts +70 -291
  128. package/core/config/schema.ts +42 -723
  129. package/core/framework/client.ts +131 -131
  130. package/core/framework/index.ts +7 -7
  131. package/core/framework/server.ts +47 -40
  132. package/core/framework/types.ts +2 -2
  133. package/core/index.ts +23 -4
  134. package/core/live/ComponentRegistry.ts +3 -3
  135. package/core/live/types.ts +77 -0
  136. package/core/plugins/built-in/index.ts +134 -134
  137. package/core/plugins/built-in/live-components/commands/create-live-component.ts +242 -1066
  138. package/core/plugins/built-in/live-components/index.ts +1 -1
  139. package/core/plugins/built-in/monitoring/index.ts +111 -47
  140. package/core/plugins/built-in/static/index.ts +1 -1
  141. package/core/plugins/built-in/swagger/index.ts +68 -265
  142. package/core/plugins/built-in/vite/index.ts +85 -185
  143. package/core/plugins/built-in/vite/vite-dev.ts +10 -16
  144. package/core/plugins/config.ts +9 -7
  145. package/core/plugins/dependency-manager.ts +31 -1
  146. package/core/plugins/discovery.ts +19 -7
  147. package/core/plugins/executor.ts +2 -2
  148. package/core/plugins/index.ts +203 -203
  149. package/core/plugins/manager.ts +27 -39
  150. package/core/plugins/module-resolver.ts +19 -8
  151. package/core/plugins/registry.ts +255 -19
  152. package/core/plugins/types.ts +20 -53
  153. package/core/server/framework.ts +66 -43
  154. package/core/server/index.ts +15 -15
  155. package/core/server/live/ComponentRegistry.ts +78 -71
  156. package/core/server/live/FileUploadManager.ts +23 -10
  157. package/core/server/live/LiveComponentPerformanceMonitor.ts +1 -1
  158. package/core/server/live/LiveRoomManager.ts +261 -0
  159. package/core/server/live/RoomEventBus.ts +234 -0
  160. package/core/server/live/RoomStateManager.ts +172 -0
  161. package/core/server/live/StateSignature.ts +643 -643
  162. package/core/server/live/WebSocketConnectionManager.ts +30 -19
  163. package/core/server/live/auto-generated-components.ts +21 -9
  164. package/core/server/live/index.ts +14 -0
  165. package/core/server/live/websocket-plugin.ts +214 -67
  166. package/core/server/middleware/elysia-helpers.ts +7 -2
  167. package/core/server/middleware/errorHandling.ts +1 -1
  168. package/core/server/middleware/index.ts +31 -31
  169. package/core/server/plugins/database.ts +180 -180
  170. package/core/server/plugins/static-files-plugin.ts +69 -69
  171. package/core/server/plugins/swagger.ts +1 -1
  172. package/core/server/rooms/RoomBroadcaster.ts +357 -0
  173. package/core/server/rooms/RoomSystem.ts +463 -0
  174. package/core/server/rooms/index.ts +13 -0
  175. package/core/server/services/BaseService.ts +1 -1
  176. package/core/server/services/ServiceContainer.ts +1 -1
  177. package/core/server/services/index.ts +8 -8
  178. package/core/templates/create-project.ts +12 -12
  179. package/core/testing/index.ts +9 -9
  180. package/core/testing/setup.ts +73 -73
  181. package/core/types/api.ts +168 -168
  182. package/core/types/build.ts +219 -219
  183. package/core/types/config.ts +56 -26
  184. package/core/types/index.ts +4 -4
  185. package/core/types/plugin.ts +107 -107
  186. package/core/types/types.ts +353 -14
  187. package/core/utils/build-logger.ts +324 -324
  188. package/core/utils/config-schema.ts +480 -480
  189. package/core/utils/env.ts +2 -8
  190. package/core/utils/errors/codes.ts +114 -114
  191. package/core/utils/errors/handlers.ts +36 -1
  192. package/core/utils/errors/index.ts +49 -5
  193. package/core/utils/errors/middleware.ts +113 -113
  194. package/core/utils/helpers.ts +6 -16
  195. package/core/utils/index.ts +17 -17
  196. package/core/utils/logger/colors.ts +114 -114
  197. package/core/utils/logger/config.ts +13 -9
  198. package/core/utils/logger/formatter.ts +82 -82
  199. package/core/utils/logger/group-logger.ts +101 -101
  200. package/core/utils/logger/index.ts +6 -1
  201. package/core/utils/logger/stack-trace.ts +3 -1
  202. package/core/utils/logger/startup-banner.ts +82 -82
  203. package/core/utils/logger/winston-logger.ts +152 -152
  204. package/core/utils/monitoring/index.ts +211 -211
  205. package/core/utils/sync-version.ts +66 -66
  206. package/core/utils/version.ts +1 -1
  207. package/create-fluxstack.ts +8 -7
  208. package/package.json +12 -13
  209. package/plugins/crypto-auth/cli/make-protected-route.command.ts +1 -1
  210. package/plugins/crypto-auth/client/CryptoAuthClient.ts +302 -302
  211. package/plugins/crypto-auth/client/components/index.ts +11 -11
  212. package/plugins/crypto-auth/client/index.ts +11 -11
  213. package/plugins/crypto-auth/config/index.ts +1 -1
  214. package/plugins/crypto-auth/index.ts +4 -4
  215. package/plugins/crypto-auth/package.json +65 -65
  216. package/plugins/crypto-auth/server/AuthMiddleware.ts +1 -1
  217. package/plugins/crypto-auth/server/CryptoAuthService.ts +185 -185
  218. package/plugins/crypto-auth/server/index.ts +21 -21
  219. package/plugins/crypto-auth/server/middlewares/cryptoAuthAdmin.ts +3 -3
  220. package/plugins/crypto-auth/server/middlewares/cryptoAuthOptional.ts +1 -1
  221. package/plugins/crypto-auth/server/middlewares/cryptoAuthPermissions.ts +2 -2
  222. package/plugins/crypto-auth/server/middlewares/cryptoAuthRequired.ts +2 -2
  223. package/plugins/crypto-auth/server/middlewares/helpers.ts +1 -1
  224. package/plugins/crypto-auth/server/middlewares/index.ts +22 -22
  225. package/tsconfig.api-strict.json +16 -0
  226. package/tsconfig.json +48 -52
  227. package/{app/client/tsconfig.node.json → tsconfig.node.json} +25 -25
  228. package/types/global.d.ts +29 -29
  229. package/types/vitest.d.ts +8 -8
  230. package/vite.config.ts +38 -62
  231. package/vitest.config.live.ts +10 -9
  232. package/vitest.config.ts +29 -17
  233. package/app/client/README.md +0 -69
  234. package/app/client/SIMPLIFICATION.md +0 -140
  235. package/app/client/frontend-only.ts +0 -12
  236. package/app/client/src/live/FileUploadExample.tsx +0 -359
  237. package/app/client/src/live/MinimalLiveClock.tsx +0 -47
  238. package/app/client/src/live/QuickUploadTest.tsx +0 -193
  239. package/app/client/tsconfig.app.json +0 -45
  240. package/app/client/tsconfig.json +0 -7
  241. package/app/client/zustand-setup.md +0 -65
  242. package/app/server/backend-only.ts +0 -18
  243. package/app/server/live/LiveClockComponent.ts +0 -215
  244. package/app/server/live/LiveFileUploadComponent.ts +0 -77
  245. package/app/server/routes/env-test.ts +0 -110
  246. package/core/client/hooks/index.ts +0 -7
  247. package/core/client/hooks/useHybridLiveComponent.ts +0 -685
  248. package/core/client/hooks/useTypedLiveComponent.ts +0 -133
  249. package/core/client/hooks/useWebSocket.ts +0 -361
  250. package/core/config/env.ts +0 -546
  251. package/core/config/loader.ts +0 -522
  252. package/core/config/runtime-config.ts +0 -327
  253. package/core/config/validator.ts +0 -540
  254. package/core/server/backend-entry.ts +0 -51
  255. package/core/server/standalone.ts +0 -106
  256. package/core/utils/regenerate-files.ts +0 -69
  257. package/fluxstack.config.ts +0 -354
package/.dockerignore CHANGED
@@ -48,9 +48,8 @@ docs/
48
48
  # Development tools
49
49
  .eslintrc*
50
50
  .prettierrc*
51
- tsconfig*.json
52
51
  vitest.config.ts
53
- vite.config.ts
52
+ # Note: tsconfig.json is needed for Bun path alias resolution during build
54
53
 
55
54
  # OS files
56
55
  .DS_Store
package/Dockerfile CHANGED
@@ -1,10 +1,10 @@
1
- # 🐳 FluxStack Production Dockerfile
1
+ # FluxStack Production Dockerfile
2
2
  # Multi-stage build for optimized production image
3
3
 
4
4
  # =====================================
5
5
  # Stage 1: Dependencies
6
6
  # =====================================
7
- FROM oven/bun:1.1.34-alpine AS deps
7
+ FROM oven/bun:1.2-alpine AS deps
8
8
 
9
9
  WORKDIR /app
10
10
 
@@ -17,7 +17,7 @@ RUN bun install --production --frozen-lockfile
17
17
  # =====================================
18
18
  # Stage 2: Builder
19
19
  # =====================================
20
- FROM oven/bun:1.1.34-alpine AS builder
20
+ FROM oven/bun:1.2-alpine AS builder
21
21
 
22
22
  WORKDIR /app
23
23
 
@@ -34,7 +34,7 @@ RUN bun run build
34
34
  # =====================================
35
35
  # Stage 3: Production Runner
36
36
  # =====================================
37
- FROM oven/bun:1.1.34-alpine AS runner
37
+ FROM oven/bun:1.2-alpine AS runner
38
38
 
39
39
  WORKDIR /app
40
40
 
@@ -62,9 +62,9 @@ USER fluxstack
62
62
  # Expose application port
63
63
  EXPOSE 3000
64
64
 
65
- # Health check disabled for now
66
- # HEALTHCHECK --interval=30s --timeout=10s --start-period=40s --retries=3 \
67
- # CMD bun run -e 'fetch("http://localhost:3000/api/health").then(r => r.ok ? process.exit(0) : process.exit(1))' || exit 1
65
+ # Health check for container orchestrators
66
+ HEALTHCHECK --interval=30s --timeout=10s --start-period=40s --retries=3 \
67
+ CMD bun -e 'fetch("http://localhost:3000/api/health").then(r => r.ok ? process.exit(0) : process.exit(1)).catch(() => process.exit(1))'
68
68
 
69
69
  # Start the application
70
- CMD ["bun", "run", "start"]
70
+ CMD ["bun", "dist/index.js"]
package/LLMD/INDEX.md ADDED
@@ -0,0 +1,64 @@
1
+ # FluxStack LLM Documentation
2
+
3
+ **Version:** 1.12.0 | **Framework:** Bun + Elysia + React + Eden Treaty
4
+
5
+ ## Quick Navigation
6
+
7
+ **First Time?** → [core/framework-lifecycle.md](core/framework-lifecycle.md)
8
+ **Creating Routes?** → [resources/routes-eden.md](resources/routes-eden.md)
9
+ **Real-time Rooms?** → [resources/live-rooms.md](resources/live-rooms.md)
10
+ **Config Issues?** → [config/declarative-system.md](config/declarative-system.md)
11
+ **Plugin Development?** → [resources/plugins-external.md](resources/plugins-external.md)
12
+ **Errors?** → [reference/troubleshooting.md](reference/troubleshooting.md)
13
+
14
+ ## Core Concepts
15
+
16
+ - [Framework Lifecycle](core/framework-lifecycle.md) - Startup, request handling, shutdown
17
+ - [Plugin System](core/plugin-system.md) - Architecture, hooks, load order
18
+ - [Build System](core/build-system.md) - Dev vs production builds
19
+
20
+ ## Configuration
21
+
22
+ - [Declarative System](config/declarative-system.md) - defineConfig, validation, types
23
+ - [Environment Variables](config/environment-vars.md) - Complete reference
24
+ - [Runtime Reload](config/runtime-reload.md) - Hot config updates
25
+
26
+ ## Creating Resources
27
+
28
+ - [Routes with Eden Treaty](resources/routes-eden.md) - Type-safe API routes
29
+ - [Controllers & Services](resources/controllers.md) - Business logic patterns
30
+ - [Live Components](resources/live-components.md) - WebSocket components
31
+ - [Live Rooms](resources/live-rooms.md) - Multi-room real-time communication
32
+ - [Live Upload](resources/live-upload.md) - Chunked upload via Live Components
33
+ - [External Plugins](resources/plugins-external.md) - Plugin development
34
+ - [Routing (React Router v7)](reference/routing.md) - Frontend routing setup
35
+
36
+ ## Patterns & Rules
37
+
38
+ - [Project Structure](patterns/project-structure.md) - Folder organization
39
+ - [Type Safety](patterns/type-safety.md) - Eden Treaty type flow
40
+ - [Anti-Patterns](patterns/anti-patterns.md) - What NOT to do
41
+
42
+ ## Reference
43
+
44
+ - [CLI Commands](reference/cli-commands.md) - Complete command reference
45
+ - [Plugin Hooks](reference/plugin-hooks.md) - All available hooks
46
+ - [Troubleshooting](reference/troubleshooting.md) - Common issues
47
+
48
+ ## Critical Rules
49
+
50
+ **NEVER:**
51
+ - Modify files in `core/` (framework is read-only)
52
+ - Wrap Eden Treaty in custom functions
53
+ - Omit response schemas in routes
54
+
55
+ **ALWAYS:**
56
+ - Work in `app/` directory
57
+ - Use native Eden Treaty: `const { data, error } = await api.users.get()`
58
+ - Define shared types in `app/shared/`
59
+ - Run `bun run dev` after changes
60
+
61
+ ## Migration & Maintenance
62
+
63
+ - [MIGRATION.md](MIGRATION.md) - Changes from `ai-context/` to `LLMD/`
64
+ - [MAINTENANCE.md](MAINTENANCE.md) - How to update this documentation
@@ -0,0 +1,197 @@
1
+ # Documentation Maintenance Guide
2
+
3
+ **Version:** 1.11.0 | **Updated:** 2025-02-08
4
+
5
+ ## Quick Facts
6
+
7
+ - Documentation lives in `/LLMD/`
8
+ - Each document tracks version and update date
9
+ - Target: <2000 tokens per document
10
+ - All internal links must be validated
11
+
12
+ ## Document Format
13
+
14
+ Every document follows this template:
15
+
16
+ ```markdown
17
+ # Document Title
18
+
19
+ **Version:** X.Y.Z | **Updated:** YYYY-MM-DD
20
+
21
+ ## Quick Facts
22
+
23
+ - Key point 1
24
+ - Key point 2
25
+
26
+ ## [Main Sections]
27
+
28
+ Content...
29
+
30
+ ## Related
31
+
32
+ - [Link 1](./path.md)
33
+ - [Link 2](./path.md)
34
+ ```
35
+
36
+ ## When to Update Documentation
37
+
38
+ ### Code Changes That Require Doc Updates
39
+
40
+ | Change Type | Update Required |
41
+ |-------------|-----------------|
42
+ | New CLI command | `reference/cli-commands.md` |
43
+ | New plugin hook | `reference/plugin-hooks.md`, `core/plugin-system.md` |
44
+ | New config option | `config/environment-vars.md`, `config/declarative-system.md` |
45
+ | Changed API pattern | `resources/routes-eden.md`, `patterns/type-safety.md` |
46
+ | New framework feature | Relevant `core/*.md` file |
47
+ | Build system change | `core/build-system.md` |
48
+ | Breaking change | `patterns/anti-patterns.md`, `reference/troubleshooting.md` |
49
+
50
+ ### Version Bump Checklist
51
+
52
+ When FluxStack version changes:
53
+
54
+ 1. Update `**Version:**` header in all `.md` files
55
+ 2. Update `MIGRATION.md` if needed
56
+ 3. Add new entries to `reference/troubleshooting.md` for version-specific issues
57
+ 4. Update `INDEX.md` if new documents added
58
+
59
+ ## Adding New Documentation
60
+
61
+ ### New Document Checklist
62
+
63
+ 1. **Create file** in appropriate directory:
64
+ - `core/` - Framework internals
65
+ - `config/` - Configuration system
66
+ - `resources/` - Creating things (routes, controllers, plugins)
67
+ - `patterns/` - Best practices and rules
68
+ - `reference/` - Quick lookup (CLI, hooks, troubleshooting)
69
+
70
+ 2. **Add header** with version and date
71
+
72
+ 3. **Add to INDEX.md** in the right section
73
+
74
+ 4. **Add Related links** at bottom of new document
75
+
76
+ 5. **Cross-link** from related existing documents
77
+
78
+ ### Token Efficiency Guidelines
79
+
80
+ - No prose introductions ("In this document we will...")
81
+ - Use tables for reference data
82
+ - Use code blocks, not explanations of code
83
+ - Bullet points over paragraphs
84
+ - No repeated information (link instead)
85
+
86
+ ## Link Validation
87
+
88
+ ### Manual Check
89
+
90
+ ```bash
91
+ # Find all internal links
92
+ grep -r "\]\(./" LLMD/ | grep "\.md"
93
+
94
+ # Verify each path exists
95
+ ```
96
+
97
+ ### Required Links to Check
98
+
99
+ Each document should have working links in:
100
+ - `## Related` section at bottom
101
+ - Any inline references
102
+
103
+ ## Directory Structure
104
+
105
+ ```
106
+ LLMD/
107
+ ├── INDEX.md # Navigation hub (update for new docs)
108
+ ├── MIGRATION.md # Changes from ai-context/
109
+ ├── MAINTENANCE.md # This file
110
+ ├── core/
111
+ │ ├── framework-lifecycle.md
112
+ │ ├── plugin-system.md
113
+ │ └── build-system.md
114
+ ├── config/
115
+ │ ├── declarative-system.md
116
+ │ ├── environment-vars.md
117
+ │ └── runtime-reload.md
118
+ ├── resources/
119
+ │ ├── routes-eden.md
120
+ │ ├── controllers.md
121
+ │ ├── live-components.md
122
+ │ └── plugins-external.md
123
+ ├── patterns/
124
+ │ ├── project-structure.md
125
+ │ ├── type-safety.md
126
+ │ └── anti-patterns.md
127
+ └── reference/
128
+ ├── cli-commands.md
129
+ ├── plugin-hooks.md
130
+ └── troubleshooting.md
131
+ ```
132
+
133
+ ## Code Example Standards
134
+
135
+ ### TypeScript Examples
136
+
137
+ ```typescript
138
+ // ✅ Include imports when non-obvious
139
+ import { Elysia, t } from 'elysia'
140
+
141
+ // ✅ Show complete, runnable snippets
142
+ export const route = new Elysia()
143
+ .get('/', () => ({ status: 'ok' }))
144
+ ```
145
+
146
+ ### Bash Examples
147
+
148
+ ```bash
149
+ # ✅ Include expected output when helpful
150
+ bun run dev
151
+ # ⚡ Starting Full-stack development server...
152
+ # Backend: http://localhost:3000
153
+ # Frontend: http://localhost:5173
154
+ ```
155
+
156
+ ### Avoid
157
+
158
+ ```typescript
159
+ // ❌ Incomplete snippets
160
+ .get('/', () => ...)
161
+
162
+ // ❌ Unexplained magic
163
+ const x = doSomething() // What is doSomething?
164
+ ```
165
+
166
+ ## Sync with Code Changes
167
+
168
+ ### Before PR
169
+
170
+ 1. Check if code changes affect documentation
171
+ 2. Update relevant documents
172
+ 3. Update version dates
173
+ 4. Validate links
174
+
175
+ ### After Major Feature
176
+
177
+ 1. Create new document if needed
178
+ 2. Update INDEX.md
179
+ 3. Add to MIGRATION.md for notable changes
180
+ 4. Cross-reference from related docs
181
+
182
+ ## Quality Checklist
183
+
184
+ Before committing documentation changes:
185
+
186
+ - [ ] Version and date updated
187
+ - [ ] All code examples syntactically valid
188
+ - [ ] All internal links work
189
+ - [ ] No duplicate information (link instead)
190
+ - [ ] Added to INDEX.md if new document
191
+ - [ ] Related section has relevant links
192
+ - [ ] Token count reasonable (<2000 target)
193
+
194
+ ## Related
195
+
196
+ - [INDEX.md](./INDEX.md) - Main navigation
197
+ - [MIGRATION.md](./MIGRATION.md) - Version changes
@@ -0,0 +1,156 @@
1
+ # Migration Guide: ai-context/ → LLMD/
2
+
3
+ **Version:** 1.11.0 | **Updated:** 2025-02-08
4
+
5
+ ## Overview
6
+
7
+ This document explains the migration from the old `ai-context/` documentation structure to the new `LLMD/` (LLM Documentation) structure. The new system is optimized for token efficiency, direct information access, and accurate reflection of the current codebase.
8
+
9
+ ## Key Changes
10
+
11
+ ### Philosophy Shift
12
+
13
+ **Old (`ai-context/`):**
14
+ - Mixed Portuguese and English content
15
+ - Verbose explanations with context
16
+ - Scattered information across multiple files
17
+ - Some outdated content from v1.9
18
+
19
+ **New (`LLMD/`):**
20
+ - English-only for consistency
21
+ - Direct, technical language without fluff
22
+ - Modular organization by domain
23
+ - Reflects current v1.11.0 codebase
24
+ - Single entrypoint (INDEX.md) for quick navigation
25
+
26
+ ### Directory Structure Mapping
27
+
28
+ | Old Location | New Location | Notes |
29
+ |-------------|--------------|-------|
30
+ | `ai-context/00-QUICK-START.md` | `LLMD/INDEX.md` | Now a navigation hub |
31
+ | `ai-context/project/overview.md` | `LLMD/core/framework-lifecycle.md` | More detailed lifecycle |
32
+ | `ai-context/project/architecture.md` | `LLMD/core/plugin-system.md` | Split into focused docs |
33
+ | `ai-context/project/configuration.md` | `LLMD/config/declarative-system.md` | Expanded config docs |
34
+ | `ai-context/project/build-pipeline.md` | `LLMD/core/build-system.md` | Updated for v1.11.0 |
35
+ | `ai-context/development/patterns.md` | `LLMD/patterns/project-structure.md` | Split by topic |
36
+ | `ai-context/development/eden-treaty-guide.md` | `LLMD/resources/routes-eden.md` | Focused on route creation |
37
+ | `ai-context/development/plugins-guide.md` | `LLMD/resources/plugins-external.md` | Plugin development only |
38
+ | `ai-context/development/live-components.md` | `LLMD/resources/live-components.md` | Maintained |
39
+ | `ai-context/development/monitoring.md` | *(Removed)* | Not core framework feature |
40
+ | `ai-context/reference/environment-vars.md` | `LLMD/config/environment-vars.md` | Comprehensive table format |
41
+ | `ai-context/reference/cli-commands.md` | `LLMD/reference/cli-commands.md` | Complete command reference |
42
+ | `ai-context/reference/config-api.md` | `LLMD/config/runtime-reload.md` | Focused on reload mechanism |
43
+ | `ai-context/reference/troubleshooting.md` | `LLMD/reference/troubleshooting.md` | Updated for v1.11.0 |
44
+ | `ai-context/examples/crud-complete.md` | *(Integrated)* | Examples now inline in docs |
45
+ | `ai-context/recent-changes/` | *(Removed)* | Version tracking in each doc |
46
+
47
+ ## Content Changes
48
+
49
+ ### What's New in LLMD/
50
+
51
+ 1. **Plugin Hooks Reference** (`reference/plugin-hooks.md`)
52
+ - Complete hook reference table
53
+ - Execution order documentation
54
+ - Hook context interfaces
55
+
56
+ 2. **Type Safety Patterns** (`patterns/type-safety.md`)
57
+ - Eden Treaty type flow diagrams
58
+ - Type inference examples
59
+ - Common type issues
60
+
61
+ 3. **Anti-Patterns** (`patterns/anti-patterns.md`)
62
+ - Common mistakes and violations
63
+ - What NOT to do
64
+ - Framework rules enforcement
65
+
66
+ 4. **Runtime Configuration** (`config/runtime-reload.md`)
67
+ - ReactiveConfig usage
68
+ - Hot reload mechanism
69
+ - Watch callbacks
70
+
71
+ 5. **Controllers Pattern** (`resources/controllers.md`)
72
+ - Business logic separation
73
+ - Service layer patterns
74
+ - Error handling
75
+
76
+ ### What's Removed
77
+
78
+ - **Monitoring documentation**: Not a core framework feature (plugin-specific)
79
+ - **Recent changes directory**: Version tracking now in each document
80
+ - **Verbose examples**: Replaced with minimal, inline examples
81
+ - **Portuguese content**: All content now in English
82
+
83
+ ### What's Updated
84
+
85
+ - **Version**: All docs reflect v1.11.0
86
+ - **Code examples**: Validated against current codebase
87
+ - **Environment variables**: Complete and accurate list
88
+ - **CLI commands**: All current commands documented
89
+ - **Plugin system**: Updated with latest architecture
90
+
91
+ ## Migration Timeline
92
+
93
+ ### Phase 1: Coexistence (Current)
94
+ - Both `ai-context/` and `LLMD/` exist
95
+ - `ai-context/` marked as deprecated
96
+ - New content goes to `LLMD/`
97
+
98
+ ### Phase 2: Transition (Future)
99
+ - Update all references to point to `LLMD/`
100
+ - Add redirects in `ai-context/` files
101
+ - Keep `ai-context/` for reference
102
+
103
+ ### Phase 3: Deprecation (Future)
104
+ - Archive `ai-context/` to separate branch
105
+ - Remove from main branch
106
+ - `LLMD/` becomes primary documentation
107
+
108
+ ## How to Use LLMD/
109
+
110
+ ### For LLMs
111
+
112
+ 1. **Start with INDEX.md**: Single entrypoint with navigation
113
+ 2. **Load only what you need**: Modular files save tokens
114
+ 3. **Check version**: Each doc includes version and update date
115
+ 4. **Follow links**: Related docs are cross-referenced
116
+
117
+ ### For Developers
118
+
119
+ 1. **Quick reference**: INDEX.md has all critical rules
120
+ 2. **Deep dive**: Follow links to specific topics
121
+ 3. **Troubleshooting**: reference/troubleshooting.md for common issues
122
+ 4. **Examples**: Inline examples in each resource doc
123
+
124
+ ## Quick Reference Mapping
125
+
126
+ ### Common Tasks
127
+
128
+ | Task | Old Path | New Path |
129
+ |------|----------|----------|
130
+ | Create a route | `development/eden-treaty-guide.md` | `resources/routes-eden.md` |
131
+ | Configure app | `project/configuration.md` | `config/declarative-system.md` |
132
+ | Create plugin | `development/plugins-guide.md` | `resources/plugins-external.md` |
133
+ | Fix errors | `reference/troubleshooting.md` | `reference/troubleshooting.md` |
134
+ | Understand lifecycle | `project/architecture.md` | `core/framework-lifecycle.md` |
135
+ | CLI commands | `reference/cli-commands.md` | `reference/cli-commands.md` |
136
+
137
+ ### Critical Rules (Unchanged)
138
+
139
+ These rules remain the same in both documentation systems:
140
+
141
+ - **NEVER** modify files in `core/` (framework is read-only)
142
+ - **NEVER** wrap Eden Treaty in custom functions
143
+ - **NEVER** omit response schemas in routes
144
+ - **ALWAYS** work in `app/` directory
145
+ - **ALWAYS** use native Eden Treaty: `const { data, error } = await api.users.get()`
146
+ - **ALWAYS** define shared types in `app/shared/`
147
+
148
+ ## Feedback
149
+
150
+ If you find outdated content or missing information in `LLMD/`, please update the relevant document and increment the update date.
151
+
152
+ ## Related Documents
153
+
154
+ - [INDEX.md](INDEX.md) - Main navigation hub
155
+ - [requirements.md](../.kiro/specs/llm-docs-refactor/requirements.md) - Requirements for this refactor
156
+ - [design.md](../.kiro/specs/llm-docs-refactor/design.md) - Design decisions
@@ -0,0 +1 @@
1
+ # Configuration documentation directory