@atlashub/smartstack-cli 3.39.0 → 3.41.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.
- package/.documentation/apex.html +644 -644
- package/.documentation/css/styles.css +2320 -2320
- package/.documentation/init.html +1377 -1377
- package/.documentation/js/app.js +780 -780
- package/.documentation/prd-json-v2.0.0.md +396 -396
- package/.documentation/testing-ba-e2e.md +462 -462
- package/config/default-config.json +95 -95
- package/config/mcp-defaults.json +62 -62
- package/config/settings.json +53 -53
- package/config/settings.local.example.json +16 -16
- package/dist/index.js +6 -3
- package/dist/index.js.map +1 -1
- package/dist/mcp-entry.mjs +6 -4
- package/dist/mcp-entry.mjs.map +1 -1
- package/package.json +115 -115
- package/scripts/extract-api-endpoints.ts +325 -325
- package/scripts/extract-business-rules.ts +440 -440
- package/scripts/generate-doc-with-mock-ui.ts +804 -804
- package/scripts/health-check.sh +168 -168
- package/scripts/postinstall.js +18 -18
- package/templates/agents/action.md +37 -37
- package/templates/agents/ba-reader.md +378 -378
- package/templates/agents/ba-writer.md +861 -861
- package/templates/agents/code-reviewer.md +163 -163
- package/templates/agents/db-reader.md +149 -149
- package/templates/agents/docs-context-reader.md +143 -143
- package/templates/agents/docs-sync-checker.md +122 -122
- package/templates/agents/efcore/conflicts.md +95 -84
- package/templates/agents/efcore/db-deploy.md +85 -74
- package/templates/agents/efcore/db-reset.md +96 -85
- package/templates/agents/efcore/db-seed.md +72 -61
- package/templates/agents/efcore/db-status.md +97 -86
- package/templates/agents/efcore/migration.md +197 -186
- package/templates/agents/efcore/rebase-snapshot.md +119 -108
- package/templates/agents/efcore/scan.md +103 -92
- package/templates/agents/efcore/squash.md +172 -161
- package/templates/agents/explore-codebase.md +66 -66
- package/templates/agents/explore-docs.md +98 -98
- package/templates/agents/fix-grammar.md +50 -50
- package/templates/agents/gitflow/abort.md +45 -45
- package/templates/agents/gitflow/cleanup.md +96 -96
- package/templates/agents/gitflow/commit.md +236 -236
- package/templates/agents/gitflow/exec.md +48 -48
- package/templates/agents/gitflow/finish.md +146 -146
- package/templates/agents/gitflow/init-clone.md +199 -199
- package/templates/agents/gitflow/init-detect.md +137 -137
- package/templates/agents/gitflow/init-validate.md +225 -225
- package/templates/agents/gitflow/init.md +340 -340
- package/templates/agents/gitflow/merge.md +145 -145
- package/templates/agents/gitflow/plan.md +42 -42
- package/templates/agents/gitflow/pr.md +191 -191
- package/templates/agents/gitflow/review.md +49 -49
- package/templates/agents/gitflow/start.md +147 -147
- package/templates/agents/gitflow/status.md +95 -95
- package/templates/agents/mcp-healthcheck.md +163 -163
- package/templates/agents/snipper.md +37 -37
- package/templates/agents/websearch.md +46 -46
- package/templates/hooks/appsettings-guard.sh +76 -76
- package/templates/hooks/docs-drift-check.md +96 -96
- package/templates/hooks/ef-migration-check.md +139 -139
- package/templates/hooks/hooks.json +58 -58
- package/templates/hooks/mcp-check.md +64 -64
- package/templates/hooks/ralph-mcp-logger.sh +46 -46
- package/templates/hooks/ralph-session-end.sh +69 -69
- package/templates/hooks/stop-hook.sh +177 -177
- package/templates/hooks/wsl-dotnet-cleanup.sh +24 -24
- package/templates/mcp-scaffolding/component.tsx.hbs +318 -318
- package/templates/mcp-scaffolding/controller.cs.hbs +192 -192
- package/templates/mcp-scaffolding/entity-extension.cs.hbs +239 -239
- package/templates/mcp-scaffolding/frontend/api-client.ts.hbs +116 -116
- package/templates/mcp-scaffolding/frontend/nav-routes.ts.hbs +133 -133
- package/templates/mcp-scaffolding/frontend/routes.tsx.hbs +126 -126
- package/templates/mcp-scaffolding/migrations/seed-roles.cs.hbs +261 -261
- package/templates/mcp-scaffolding/service-extension.cs.hbs +53 -53
- package/templates/mcp-scaffolding/tests/controller.test.cs.hbs +436 -436
- package/templates/mcp-scaffolding/tests/entity.test.cs.hbs +239 -239
- package/templates/mcp-scaffolding/tests/repository.test.cs.hbs +441 -441
- package/templates/mcp-scaffolding/tests/security.test.cs.hbs +442 -442
- package/templates/mcp-scaffolding/tests/service.test.cs.hbs +402 -402
- package/templates/mcp-scaffolding/tests/validator.test.cs.hbs +428 -428
- package/templates/project/DependencyInjection.Application.cs.template +25 -25
- package/templates/project/DependencyInjection.Infrastructure.cs.template +61 -61
- package/templates/project/DesignTimeExtensionsDbContextFactory.cs.template +70 -70
- package/templates/project/ExampleEntity.cs.template +116 -116
- package/templates/project/ExampleEntityConfiguration.cs.template +64 -64
- package/templates/project/ExampleService.cs.template +146 -146
- package/templates/project/ExtensionsDbContext.cs.template +41 -41
- package/templates/project/IExtensionsDbContext.cs.template +22 -22
- package/templates/project/Program.cs.template +47 -47
- package/templates/project/README.md +79 -79
- package/templates/project/api.ts.template +12 -12
- package/templates/project/appsettings.json.template +170 -170
- package/templates/project/claude-settings.json.template +5 -5
- package/templates/project/test-frontend/msw/handlers.ts +58 -58
- package/templates/project/test-frontend/msw/server.ts +25 -25
- package/templates/project/test-frontend/setup.ts +16 -16
- package/templates/project/test-frontend/test-utils.tsx +59 -59
- package/templates/project/test-frontend/vitest.config.ts +31 -31
- package/templates/ralph/README.md +93 -93
- package/templates/ralph/ralph.config.yaml +113 -113
- package/templates/scripts/setup-ralph-loop.sh +173 -173
- package/templates/skills/_resources/config-safety.md +61 -61
- package/templates/skills/_resources/context-digest-template.md +53 -53
- package/templates/skills/_resources/doc-context-cache.md +60 -60
- package/templates/skills/_resources/docs-manifest-schema.md +155 -155
- package/templates/skills/_resources/formatting-guide.md +124 -124
- package/templates/skills/_resources/mcp-validate-documentation-spec.md +181 -181
- package/templates/skills/_shared.md +228 -228
- package/templates/skills/admin/SKILL.md +48 -48
- package/templates/skills/ai-prompt/SKILL.md +107 -107
- package/templates/skills/ai-prompt/steps/step-00-init.md +47 -47
- package/templates/skills/ai-prompt/steps/step-01-implementation.md +122 -122
- package/templates/skills/apex/SKILL.md +168 -168
- package/templates/skills/apex/_shared.md +141 -141
- package/templates/skills/apex/references/agent-teams-protocol.md +164 -164
- package/templates/skills/apex/references/analysis-methods.md +141 -141
- package/templates/skills/apex/references/challenge-questions.md +145 -145
- package/templates/skills/apex/references/code-generation.md +412 -412
- package/templates/skills/apex/references/core-seed-data.md +1437 -1437
- package/templates/skills/apex/references/error-classification.md +144 -144
- package/templates/skills/apex/references/examine-build-validation.md +82 -82
- package/templates/skills/apex/references/execution-frontend-gates.md +177 -177
- package/templates/skills/apex/references/execution-frontend-patterns.md +105 -105
- package/templates/skills/apex/references/execution-layer1-rules.md +96 -96
- package/templates/skills/apex/references/initialization-challenge-flow.md +110 -110
- package/templates/skills/apex/references/planning-layer-mapping.md +151 -151
- package/templates/skills/apex/references/post-checks.md +1584 -1584
- package/templates/skills/apex/references/smartstack-api.md +1053 -1053
- package/templates/skills/apex/references/smartstack-frontend.md +1571 -1571
- package/templates/skills/apex/references/smartstack-layers.md +402 -402
- package/templates/skills/apex/steps/step-00-init.md +307 -307
- package/templates/skills/apex/steps/step-01-analyze.md +165 -165
- package/templates/skills/apex/steps/step-02-plan.md +144 -144
- package/templates/skills/apex/steps/step-03-execute.md +328 -328
- package/templates/skills/apex/steps/step-04-examine.md +263 -263
- package/templates/skills/apex/steps/step-05-deep-review.md +129 -129
- package/templates/skills/apex/steps/step-06-resolve.md +101 -101
- package/templates/skills/apex/steps/step-07-tests.md +238 -238
- package/templates/skills/apex/steps/step-08-run-tests.md +125 -125
- package/templates/skills/application/SKILL.md +4 -4
- package/templates/skills/application/references/application-roles-template.md +227 -227
- package/templates/skills/application/references/backend-controller-hierarchy.md +58 -58
- package/templates/skills/application/references/backend-entity-seeding.md +72 -72
- package/templates/skills/application/references/backend-seeding-and-dto-output.md +83 -83
- package/templates/skills/application/references/backend-table-prefix-mapping.md +79 -79
- package/templates/skills/application/references/backend-verification.md +88 -88
- package/templates/skills/application/references/frontend-i18n-and-output.md +67 -67
- package/templates/skills/application/references/frontend-route-naming.md +117 -117
- package/templates/skills/application/references/frontend-route-wiring-app-tsx.md +107 -107
- package/templates/skills/application/references/frontend-verification.md +156 -156
- package/templates/skills/application/references/migration-checklist-troubleshooting.md +1 -1
- package/templates/skills/application/references/provider-template.md +177 -177
- package/templates/skills/application/references/roles-client-project-handling.md +55 -55
- package/templates/skills/application/references/roles-fallback-procedure.md +149 -149
- package/templates/skills/application/references/test-coverage-requirements.md +213 -213
- package/templates/skills/application/references/test-frontend.md +73 -73
- package/templates/skills/application/references/test-prerequisites.md +72 -72
- package/templates/skills/application/steps/step-05-frontend.md +176 -176
- package/templates/skills/application/steps/step-06-migration.md +193 -193
- package/templates/skills/application/steps/step-07-tests.md +356 -356
- package/templates/skills/application/steps/step-08-documentation.md +137 -137
- package/templates/skills/application/templates-backend.md +463 -463
- package/templates/skills/application/templates-frontend.md +685 -685
- package/templates/skills/application/templates-i18n.md +520 -520
- package/templates/skills/application/templates-seed.md +1096 -1096
- package/templates/skills/business-analyse/SKILL.md +327 -327
- package/templates/skills/business-analyse/_architecture.md +123 -123
- package/templates/skills/business-analyse/_elicitation.md +206 -206
- package/templates/skills/business-analyse/_module-loop.md +115 -115
- package/templates/skills/business-analyse/_shared.md +383 -383
- package/templates/skills/business-analyse/_suggestions.md +34 -34
- package/templates/skills/business-analyse/html/ba-interactive.html +4477 -4477
- package/templates/skills/business-analyse/html/build-html.js +77 -77
- package/templates/skills/business-analyse/html/src/scripts/01-data-init.js +150 -150
- package/templates/skills/business-analyse/html/src/scripts/02-navigation.js +227 -227
- package/templates/skills/business-analyse/html/src/scripts/03-render-cadrage.js +199 -199
- package/templates/skills/business-analyse/html/src/scripts/04-render-modules.js +205 -205
- package/templates/skills/business-analyse/html/src/scripts/05-render-specs.js +647 -647
- package/templates/skills/business-analyse/html/src/scripts/06-render-consolidation.js +195 -195
- package/templates/skills/business-analyse/html/src/scripts/07-render-handoff.js +92 -92
- package/templates/skills/business-analyse/html/src/scripts/08-editing.js +135 -135
- package/templates/skills/business-analyse/html/src/scripts/09-export.js +168 -168
- package/templates/skills/business-analyse/html/src/scripts/10-comments.js +171 -171
- package/templates/skills/business-analyse/html/src/scripts/11-review-panel.js +166 -166
- package/templates/skills/business-analyse/html/src/styles/01-variables.css +38 -38
- package/templates/skills/business-analyse/html/src/styles/02-layout.css +101 -101
- package/templates/skills/business-analyse/html/src/styles/03-navigation.css +120 -120
- package/templates/skills/business-analyse/html/src/styles/04-cards.css +196 -196
- package/templates/skills/business-analyse/html/src/styles/05-modules.css +454 -454
- package/templates/skills/business-analyse/html/src/styles/06-wireframes.css +272 -272
- package/templates/skills/business-analyse/html/src/styles/07-comments.css +184 -184
- package/templates/skills/business-analyse/html/src/styles/08-review-panel.css +241 -241
- package/templates/skills/business-analyse/html/src/template.html +516 -516
- package/templates/skills/business-analyse/patterns/suggestion-catalog.md +546 -546
- package/templates/skills/business-analyse/questionnaire/00-application.md +160 -160
- package/templates/skills/business-analyse/questionnaire/00b-project.md +85 -85
- package/templates/skills/business-analyse/questionnaire/01-context.md +185 -185
- package/templates/skills/business-analyse/questionnaire/02-stakeholders.md +189 -189
- package/templates/skills/business-analyse/questionnaire/03-scope.md +164 -164
- package/templates/skills/business-analyse/questionnaire/04-data.md +88 -88
- package/templates/skills/business-analyse/questionnaire/05-integrations.md +58 -58
- package/templates/skills/business-analyse/questionnaire/06-security.md +68 -68
- package/templates/skills/business-analyse/questionnaire/07-ui.md +76 -76
- package/templates/skills/business-analyse/questionnaire/08-performance.md +42 -42
- package/templates/skills/business-analyse/questionnaire/09-constraints.md +45 -45
- package/templates/skills/business-analyse/questionnaire/10-documentation.md +43 -43
- package/templates/skills/business-analyse/questionnaire/11-data-lifecycle.md +59 -59
- package/templates/skills/business-analyse/questionnaire/12-migration.md +58 -58
- package/templates/skills/business-analyse/questionnaire/13-cross-module.md +69 -69
- package/templates/skills/business-analyse/questionnaire/14-risk-assumptions.md +135 -135
- package/templates/skills/business-analyse/questionnaire/15-success-metrics.md +136 -136
- package/templates/skills/business-analyse/questionnaire.md +337 -337
- package/templates/skills/business-analyse/react/application-viewer.md +242 -242
- package/templates/skills/business-analyse/react/components.md +551 -551
- package/templates/skills/business-analyse/react/i18n-template.md +306 -306
- package/templates/skills/business-analyse/references/acceptance-criteria.md +169 -169
- package/templates/skills/business-analyse/references/agent-module-prompt.md +362 -362
- package/templates/skills/business-analyse/references/agent-pooling-best-practices.md +557 -557
- package/templates/skills/business-analyse/references/analysis-semantic-checks.md +190 -190
- package/templates/skills/business-analyse/references/cache-warming-strategy.md +566 -566
- package/templates/skills/business-analyse/references/cadrage-challenge-patterns.md +41 -41
- package/templates/skills/business-analyse/references/cadrage-coverage-matrix.md +74 -74
- package/templates/skills/business-analyse/references/cadrage-pre-analysis.md +115 -115
- package/templates/skills/business-analyse/references/cadrage-shared-modules.md +68 -69
- package/templates/skills/business-analyse/references/cadrage-structure-cards.md +85 -85
- package/templates/skills/business-analyse/references/compilation-structure-cards.md +297 -297
- package/templates/skills/business-analyse/references/consolidation-structural-checks.md +107 -107
- package/templates/skills/business-analyse/references/deploy-data-build.md +180 -180
- package/templates/skills/business-analyse/references/deploy-modes.md +118 -118
- package/templates/skills/business-analyse/references/detection-strategies.md +424 -424
- package/templates/skills/business-analyse/references/entity-architecture-decision.md +218 -218
- package/templates/skills/business-analyse/references/handoff-file-templates.md +120 -120
- package/templates/skills/business-analyse/references/handoff-mappings.md +81 -81
- package/templates/skills/business-analyse/references/handoff-seeddata-generation.md +312 -312
- package/templates/skills/business-analyse/references/html-data-mapping.md +299 -299
- package/templates/skills/business-analyse/references/init-schema-deployment.md +65 -65
- package/templates/skills/business-analyse/references/naming-conventions.md +243 -243
- package/templates/skills/business-analyse/references/prd-generation.md +258 -258
- package/templates/skills/business-analyse/references/review-data-mapping.md +363 -363
- package/templates/skills/business-analyse/references/robustness-checks.md +542 -542
- package/templates/skills/business-analyse/references/spec-auto-inference.md +111 -111
- package/templates/skills/business-analyse/references/team-orchestration.md +1022 -1022
- package/templates/skills/business-analyse/references/ui-dashboard-spec.md +85 -85
- package/templates/skills/business-analyse/references/ui-resource-cards.md +259 -259
- package/templates/skills/business-analyse/references/validate-incremental-html.md +121 -121
- package/templates/skills/business-analyse/references/validation-checklist.md +347 -347
- package/templates/skills/business-analyse/references/wireframe-svg-style-guide.md +335 -335
- package/templates/skills/business-analyse/schemas/application-schema.json +453 -453
- package/templates/skills/business-analyse/schemas/feature-schema.json +53 -53
- package/templates/skills/business-analyse/schemas/project-schema.json +485 -485
- package/templates/skills/business-analyse/schemas/sections/analysis-schema.json +201 -201
- package/templates/skills/business-analyse/schemas/sections/discovery-schema.json +82 -82
- package/templates/skills/business-analyse/schemas/sections/handoff-schema.json +80 -80
- package/templates/skills/business-analyse/schemas/sections/metadata-schema.json +70 -70
- package/templates/skills/business-analyse/schemas/sections/specification-schema.json +547 -547
- package/templates/skills/business-analyse/schemas/sections/validation-schema.json +93 -93
- package/templates/skills/business-analyse/schemas/shared/common-defs.json +226 -226
- package/templates/skills/business-analyse/steps/step-00-init.md +575 -576
- package/templates/skills/business-analyse/steps/step-01-cadrage.md +767 -767
- package/templates/skills/business-analyse/steps/step-01b-applications.md +419 -419
- package/templates/skills/business-analyse/steps/step-02-decomposition.md +387 -387
- package/templates/skills/business-analyse/steps/step-03a-data.md +16 -16
- package/templates/skills/business-analyse/steps/step-03a1-setup.md +506 -506
- package/templates/skills/business-analyse/steps/step-03a2-analysis.md +252 -252
- package/templates/skills/business-analyse/steps/step-03b-ui.md +425 -425
- package/templates/skills/business-analyse/steps/step-03c-compile.md +611 -611
- package/templates/skills/business-analyse/steps/step-03d-validate.md +783 -783
- package/templates/skills/business-analyse/steps/step-04-consolidation.md +17 -17
- package/templates/skills/business-analyse/steps/step-04a-collect.md +415 -415
- package/templates/skills/business-analyse/steps/step-04b-analyze.md +163 -163
- package/templates/skills/business-analyse/steps/step-04c-decide.md +186 -186
- package/templates/skills/business-analyse/steps/step-05a-handoff.md +840 -840
- package/templates/skills/business-analyse/steps/step-05b-deploy.md +522 -522
- package/templates/skills/business-analyse/steps/step-05c-ralph-readiness.md +703 -703
- package/templates/skills/business-analyse/steps/step-06-review.md +278 -278
- package/templates/skills/business-analyse/templates/tpl-frd.md +168 -168
- package/templates/skills/business-analyse/templates/tpl-handoff.md +186 -186
- package/templates/skills/business-analyse/templates/tpl-launch-displays.md +59 -59
- package/templates/skills/business-analyse/templates/tpl-progress.md +172 -172
- package/templates/skills/business-analyse/templates-frd.md +476 -476
- package/templates/skills/business-analyse/templates-react.md +574 -574
- package/templates/skills/cc-agent/SKILL.md +129 -129
- package/templates/skills/cc-agent/references/agent-behavior-patterns.md +95 -95
- package/templates/skills/cc-agent/references/agent-frontmatter.md +213 -213
- package/templates/skills/cc-agent/references/permission-modes.md +102 -102
- package/templates/skills/cc-agent/references/tools-reference.md +144 -144
- package/templates/skills/cc-agent/steps/step-00-init.md +134 -134
- package/templates/skills/cc-agent/steps/step-01-design.md +186 -186
- package/templates/skills/cc-agent/steps/step-02-generate.md +131 -131
- package/templates/skills/cc-agent/steps/step-03-validate.md +130 -130
- package/templates/skills/cc-agent/templates/agent-categorized.md +67 -67
- package/templates/skills/cc-agent/templates/agent-standalone.md +56 -56
- package/templates/skills/cc-agent/templates/agent-with-skills.md +94 -94
- package/templates/skills/cc-audit/SKILL.md +108 -108
- package/templates/skills/cc-audit/references/agent-checklist.md +91 -91
- package/templates/skills/cc-audit/references/hook-checklist.md +110 -110
- package/templates/skills/cc-audit/references/skill-checklist.md +70 -70
- package/templates/skills/cc-audit/steps/step-00-init.md +98 -98
- package/templates/skills/cc-audit/steps/step-01-scan.md +142 -142
- package/templates/skills/cc-audit/steps/step-02-analyze.md +158 -158
- package/templates/skills/cc-audit/steps/step-03-report.md +142 -142
- package/templates/skills/cc-skill/SKILL.md +134 -134
- package/templates/skills/cc-skill/references/best-practices.md +167 -167
- package/templates/skills/cc-skill/references/frontmatter-reference.md +182 -182
- package/templates/skills/cc-skill/references/skill-patterns.md +199 -199
- package/templates/skills/cc-skill/steps/step-00-init.md +119 -119
- package/templates/skills/cc-skill/steps/step-01-design.md +199 -199
- package/templates/skills/cc-skill/steps/step-02-generate.md +145 -145
- package/templates/skills/cc-skill/steps/step-03-steps.md +151 -151
- package/templates/skills/cc-skill/steps/step-04-validate.md +124 -124
- package/templates/skills/cc-skill/templates/skill-forked.md +85 -85
- package/templates/skills/cc-skill/templates/skill-progressive.md +102 -102
- package/templates/skills/cc-skill/templates/skill-simple.md +75 -75
- package/templates/skills/cc-skill/templates/step-template.md +82 -82
- package/templates/skills/check-version/SKILL.md +196 -196
- package/templates/skills/controller/SKILL.md +162 -162
- package/templates/skills/controller/postman-templates.md +614 -614
- package/templates/skills/controller/references/controller-code-templates.md +159 -159
- package/templates/skills/controller/references/mcp-scaffold-workflow.md +209 -209
- package/templates/skills/controller/references/permission-sync-templates.md +149 -149
- package/templates/skills/controller/steps/step-00-init.md +193 -191
- package/templates/skills/controller/steps/step-01-analyze.md +146 -146
- package/templates/skills/controller/steps/step-02-plan.md +176 -176
- package/templates/skills/controller/steps/step-03-generate.md +189 -189
- package/templates/skills/controller/steps/step-04-perms.md +80 -80
- package/templates/skills/controller/steps/step-05-validate.md +107 -107
- package/templates/skills/controller/templates.md +1555 -1555
- package/templates/skills/debug/SKILL.md +70 -70
- package/templates/skills/debug/references/team-protocol.md +232 -232
- package/templates/skills/debug/steps/step-00-init.md +57 -57
- package/templates/skills/debug/steps/step-01-analyze.md +219 -219
- package/templates/skills/debug/steps/step-02-resolve.md +85 -85
- package/templates/skills/documentation/SKILL.md +132 -132
- package/templates/skills/documentation/data-schema.md +227 -227
- package/templates/skills/documentation/steps/step-00-init.md +70 -70
- package/templates/skills/documentation/steps/step-01-scan.md +113 -113
- package/templates/skills/documentation/steps/step-02-generate.md +231 -231
- package/templates/skills/documentation/steps/step-03-validate.md +251 -238
- package/templates/skills/documentation/templates.md +662 -663
- package/templates/skills/efcore/SKILL.md +168 -167
- package/templates/skills/efcore/references/both-contexts.md +32 -32
- package/templates/skills/efcore/references/database-operations.md +67 -67
- package/templates/skills/efcore/references/destructive-operations.md +38 -38
- package/templates/skills/efcore/references/reset-operations.md +81 -81
- package/templates/skills/efcore/references/seed-methods.md +86 -86
- package/templates/skills/efcore/references/shared-init-functions.md +250 -250
- package/templates/skills/efcore/references/sql-objects-injection.md +61 -61
- package/templates/skills/efcore/references/troubleshooting.md +81 -81
- package/templates/skills/efcore/references/zero-downtime-patterns.md +227 -227
- package/templates/skills/efcore/steps/db/step-deploy.md +217 -217
- package/templates/skills/efcore/steps/db/step-reset.md +186 -186
- package/templates/skills/efcore/steps/db/step-seed.md +166 -166
- package/templates/skills/efcore/steps/db/step-status.md +173 -173
- package/templates/skills/efcore/steps/migration/step-00-init.md +102 -102
- package/templates/skills/efcore/steps/migration/step-01-check.md +164 -164
- package/templates/skills/efcore/steps/migration/step-02-create.md +160 -160
- package/templates/skills/efcore/steps/migration/step-03-validate.md +168 -168
- package/templates/skills/efcore/steps/rebase-snapshot/step-00-init.md +173 -173
- package/templates/skills/efcore/steps/rebase-snapshot/step-01-backup.md +100 -100
- package/templates/skills/efcore/steps/rebase-snapshot/step-02-fetch.md +115 -115
- package/templates/skills/efcore/steps/rebase-snapshot/step-03-create.md +112 -112
- package/templates/skills/efcore/steps/rebase-snapshot/step-04-validate.md +157 -157
- package/templates/skills/efcore/steps/shared/step-00-init.md +131 -131
- package/templates/skills/efcore/steps/squash/step-00-init.md +141 -141
- package/templates/skills/efcore/steps/squash/step-01-backup.md +120 -120
- package/templates/skills/efcore/steps/squash/step-02-fetch.md +168 -168
- package/templates/skills/efcore/steps/squash/step-03-create.md +184 -184
- package/templates/skills/efcore/steps/squash/step-04-validate.md +174 -174
- package/templates/skills/explore/SKILL.md +98 -98
- package/templates/skills/feature-full/SKILL.md +111 -111
- package/templates/skills/feature-full/steps/step-00-init.md +57 -57
- package/templates/skills/feature-full/steps/step-01-implementation.md +120 -120
- package/templates/skills/gitflow/SKILL.md +377 -377
- package/templates/skills/gitflow/_shared.md +620 -620
- package/templates/skills/gitflow/phases/abort.md +189 -189
- package/templates/skills/gitflow/phases/cleanup.md +234 -234
- package/templates/skills/gitflow/phases/status.md +192 -192
- package/templates/skills/gitflow/references/commit-message-generation.md +58 -58
- package/templates/skills/gitflow/references/commit-migration-validation.md +49 -49
- package/templates/skills/gitflow/references/finish-cleanup.md +55 -55
- package/templates/skills/gitflow/references/finish-version-bumping.md +45 -45
- package/templates/skills/gitflow/references/init-config-template.md +135 -135
- package/templates/skills/gitflow/references/init-environment-detection.md +41 -41
- package/templates/skills/gitflow/references/init-name-normalization.md +103 -103
- package/templates/skills/gitflow/references/init-questions.md +185 -185
- package/templates/skills/gitflow/references/init-structure-creation.md +75 -75
- package/templates/skills/gitflow/references/init-version-detection.md +21 -21
- package/templates/skills/gitflow/references/init-workspace-detection.md +43 -43
- package/templates/skills/gitflow/references/merge-ci-status.md +36 -36
- package/templates/skills/gitflow/references/merge-execution.md +62 -62
- package/templates/skills/gitflow/references/merge-pr-context.md +76 -76
- package/templates/skills/gitflow/references/plan-template.md +69 -69
- package/templates/skills/gitflow/references/pr-build-checks.md +60 -60
- package/templates/skills/gitflow/references/pr-generation.md +58 -58
- package/templates/skills/gitflow/references/start-branch-normalization.md +28 -28
- package/templates/skills/gitflow/references/start-efcore-preflight.md +70 -70
- package/templates/skills/gitflow/references/start-local-config.md +113 -113
- package/templates/skills/gitflow/references/start-worktree-creation.md +50 -50
- package/templates/skills/gitflow/references/sync-push-verify.md +44 -44
- package/templates/skills/gitflow/references/sync-rebase-conflicts.md +38 -38
- package/templates/skills/gitflow/steps/step-commit.md +199 -199
- package/templates/skills/gitflow/steps/step-finish.md +147 -147
- package/templates/skills/gitflow/steps/step-init.md +190 -190
- package/templates/skills/gitflow/steps/step-merge.md +85 -85
- package/templates/skills/gitflow/steps/step-plan.md +151 -151
- package/templates/skills/gitflow/steps/step-pr.md +199 -199
- package/templates/skills/gitflow/steps/step-start.md +195 -195
- package/templates/skills/gitflow/steps/step-sync.md +161 -161
- package/templates/skills/gitflow/templates/config.json +72 -72
- package/templates/skills/mcp/SKILL.md +62 -62
- package/templates/skills/mcp/steps/step-01-healthcheck.md +108 -108
- package/templates/skills/mcp/steps/step-02-tools.md +73 -73
- package/templates/skills/notification/SKILL.md +173 -173
- package/templates/skills/quick-search/SKILL.md +99 -99
- package/templates/skills/ralph-loop/SKILL.md +234 -234
- package/templates/skills/ralph-loop/references/category-completeness.md +185 -185
- package/templates/skills/ralph-loop/references/category-rules.md +96 -96
- package/templates/skills/ralph-loop/references/compact-loop.md +300 -300
- package/templates/skills/ralph-loop/references/init-resume-recovery.md +127 -127
- package/templates/skills/ralph-loop/references/module-transition.md +151 -151
- package/templates/skills/ralph-loop/references/multi-module-queue.md +171 -171
- package/templates/skills/ralph-loop/references/parallel-execution.md +246 -246
- package/templates/skills/ralph-loop/references/section-splitting.md +439 -439
- package/templates/skills/ralph-loop/references/task-transform-legacy.md +256 -256
- package/templates/skills/ralph-loop/references/team-orchestration.md +547 -547
- package/templates/skills/ralph-loop/steps/step-00-init.md +150 -150
- package/templates/skills/ralph-loop/steps/step-01-task.md +174 -174
- package/templates/skills/ralph-loop/steps/step-02-execute.md +177 -177
- package/templates/skills/ralph-loop/steps/step-03-commit.md +92 -92
- package/templates/skills/ralph-loop/steps/step-04-check.md +207 -207
- package/templates/skills/ralph-loop/steps/step-05-report.md +175 -175
- package/templates/skills/refactor/SKILL.md +56 -56
- package/templates/skills/refactor/steps/step-01-discover.md +60 -60
- package/templates/skills/refactor/steps/step-02-execute.md +67 -67
- package/templates/skills/review-code/SKILL.md +95 -94
- package/templates/skills/review-code/references/clean-code-principles.md +292 -292
- package/templates/skills/review-code/references/code-quality-metrics.md +174 -174
- package/templates/skills/review-code/references/feedback-patterns.md +149 -149
- package/templates/skills/review-code/references/owasp-api-top10.md +243 -243
- package/templates/skills/review-code/references/security-checklist.md +212 -212
- package/templates/skills/review-code/steps/step-01-smartstack.md +96 -96
- package/templates/skills/review-code/steps/step-02-detailed-review.md +80 -80
- package/templates/skills/review-code/steps/step-03-react.md +44 -44
- package/templates/skills/ui-components/SKILL.md +137 -137
- package/templates/skills/ui-components/accessibility.md +170 -170
- package/templates/skills/ui-components/patterns/dashboard-chart.md +327 -327
- package/templates/skills/ui-components/patterns/data-table.md +39 -39
- package/templates/skills/ui-components/patterns/entity-card.md +77 -77
- package/templates/skills/ui-components/patterns/grid-layout.md +91 -91
- package/templates/skills/ui-components/patterns/kanban.md +43 -43
- package/templates/skills/ui-components/responsive-guidelines.md +278 -278
- package/templates/skills/ui-components/style-guide.md +113 -113
- package/templates/skills/utils/SKILL.md +44 -44
- package/templates/skills/utils/subcommands/test-web-config.md +152 -152
- package/templates/skills/utils/subcommands/test-web.md +123 -123
- package/templates/skills/validate/SKILL.md +181 -181
- package/templates/skills/validate-feature/SKILL.md +101 -101
- package/templates/skills/validate-feature/references/api-smoke-tests.md +140 -140
- package/templates/skills/validate-feature/references/db-validation-checks.md +180 -180
- package/templates/skills/validate-feature/steps/step-00-dependencies.md +121 -121
- package/templates/skills/validate-feature/steps/step-01-compile.md +39 -39
- package/templates/skills/validate-feature/steps/step-02-unit-tests.md +45 -45
- package/templates/skills/validate-feature/steps/step-03-integration-tests.md +53 -53
- package/templates/skills/validate-feature/steps/step-04-api-smoke.md +94 -94
- package/templates/skills/validate-feature/steps/step-05-db-validation.md +149 -149
- package/templates/skills/workflow/SKILL.md +127 -127
- package/templates/skills/workflow/steps/step-00-init.md +57 -57
- package/templates/skills/workflow/steps/step-01-implementation.md +84 -84
- package/templates/test-web/api-health.json +38 -38
- package/templates/test-web/minimal.json +19 -19
- package/templates/test-web/npm-package.json +46 -46
- package/templates/test-web/seo-check.json +54 -54
|
@@ -1,574 +1,574 @@
|
|
|
1
|
-
# Templates React - Documentation Module
|
|
2
|
-
|
|
3
|
-
> **Usage:** Templates for generating HTML (React) documentation of module specifications
|
|
4
|
-
> **Output:** `web/smartstack-web/src/pages/docs/{app}/{module}/`
|
|
5
|
-
> **Context7:** Use for up-to-date React code generation
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## CONTEXT7 RULE (MANDATORY)
|
|
10
|
-
|
|
11
|
-
```
|
|
12
|
-
╔══════════════════════════════════════════════════════════════════════════════╗
|
|
13
|
-
║ REACT GENERATION WITH CONTEXT7 ║
|
|
14
|
-
╠══════════════════════════════════════════════════════════════════════════════╣
|
|
15
|
-
║ ║
|
|
16
|
-
║ ALWAYS use Context7 for React component generation: ║
|
|
17
|
-
║ ║
|
|
18
|
-
║ Prompt pattern: ║
|
|
19
|
-
║ "use context7 with /facebook/react and /i18next/react-i18next ║
|
|
20
|
-
║ to generate {component} following SmartStack patterns" ║
|
|
21
|
-
║ ║
|
|
22
|
-
║ Libraries to reference: ║
|
|
23
|
-
║ • /facebook/react - React 19 patterns ║
|
|
24
|
-
║ • /i18next/react-i18next - Internationalization ║
|
|
25
|
-
║ • /remix-run/react-router - React Router v7 ║
|
|
26
|
-
║ • /lucide-icons/lucide-react - Icons ║
|
|
27
|
-
║ ║
|
|
28
|
-
╚══════════════════════════════════════════════════════════════════════════════╝
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
---
|
|
32
|
-
|
|
33
|
-
## Template DocPage.tsx
|
|
34
|
-
|
|
35
|
-
```tsx
|
|
36
|
-
// web/smartstack-web/src/pages/docs/{app}/{module}/DocPage.tsx
|
|
37
|
-
// GENERATE WITH: use context7 with /facebook/react
|
|
38
|
-
|
|
39
|
-
import { Link } from 'react-router-dom';
|
|
40
|
-
import { useTranslation } from 'react-i18next';
|
|
41
|
-
import {
|
|
42
|
-
FileText,
|
|
43
|
-
Users,
|
|
44
|
-
Shield,
|
|
45
|
-
CheckCircle,
|
|
46
|
-
AlertTriangle,
|
|
47
|
-
ChevronRight,
|
|
48
|
-
ArrowRight,
|
|
49
|
-
List,
|
|
50
|
-
Layout,
|
|
51
|
-
Database
|
|
52
|
-
} from 'lucide-react';
|
|
53
|
-
|
|
54
|
-
// Types for documentation data
|
|
55
|
-
interface UseCase {
|
|
56
|
-
id: string;
|
|
57
|
-
name: string;
|
|
58
|
-
actor: string;
|
|
59
|
-
permission: string;
|
|
60
|
-
description: string;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
interface BusinessRule {
|
|
64
|
-
id: string;
|
|
65
|
-
rule: string;
|
|
66
|
-
category: string;
|
|
67
|
-
priority: 'Must' | 'Should' | 'Could';
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
interface Permission {
|
|
71
|
-
path: string;
|
|
72
|
-
description: string;
|
|
73
|
-
roles: string[];
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
interface DocData {
|
|
77
|
-
featureId: string;
|
|
78
|
-
moduleName: string;
|
|
79
|
-
applicationName: string;
|
|
80
|
-
version: string;
|
|
81
|
-
useCases: UseCase[];
|
|
82
|
-
businessRules: BusinessRule[];
|
|
83
|
-
permissions: Permission[];
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
// Data loaded from feature.json (to be generated dynamically)
|
|
87
|
-
const docData: DocData = {
|
|
88
|
-
featureId: 'FEAT-XXX',
|
|
89
|
-
moduleName: '{ModuleName}',
|
|
90
|
-
applicationName: '{ApplicationName}',
|
|
91
|
-
version: '1.0',
|
|
92
|
-
useCases: [
|
|
93
|
-
{
|
|
94
|
-
id: 'UC-001',
|
|
95
|
-
name: '{Use Case Name}',
|
|
96
|
-
actor: '{Actor}',
|
|
97
|
-
permission: '{app}.{module}.{action}',
|
|
98
|
-
description: '{Description}'
|
|
99
|
-
}
|
|
100
|
-
],
|
|
101
|
-
businessRules: [
|
|
102
|
-
{
|
|
103
|
-
id: 'BR-001',
|
|
104
|
-
rule: '{Business Rule Description}',
|
|
105
|
-
category: 'Validation',
|
|
106
|
-
priority: 'Must'
|
|
107
|
-
}
|
|
108
|
-
],
|
|
109
|
-
permissions: [
|
|
110
|
-
{
|
|
111
|
-
path: '{app}.{module}.read',
|
|
112
|
-
description: 'View {module} data',
|
|
113
|
-
roles: ['Admin', 'Manager', 'User', 'ReadOnly']
|
|
114
|
-
},
|
|
115
|
-
{
|
|
116
|
-
path: '{app}.{module}.create',
|
|
117
|
-
description: 'Create new {module}',
|
|
118
|
-
roles: ['Admin', 'Manager']
|
|
119
|
-
}
|
|
120
|
-
]
|
|
121
|
-
};
|
|
122
|
-
|
|
123
|
-
// Priority Badge Component
|
|
124
|
-
function PriorityBadge({ priority }: { priority: string }) {
|
|
125
|
-
const colors = {
|
|
126
|
-
Must: 'bg-red-500/10 text-red-600',
|
|
127
|
-
Should: 'bg-yellow-500/10 text-yellow-600',
|
|
128
|
-
Could: 'bg-blue-500/10 text-blue-600'
|
|
129
|
-
};
|
|
130
|
-
return (
|
|
131
|
-
<span className={`px-2 py-0.5 rounded text-xs font-medium ${colors[priority as keyof typeof colors] || 'bg-gray-500/10 text-gray-600'}`}>
|
|
132
|
-
{priority}
|
|
133
|
-
</span>
|
|
134
|
-
);
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
// Numbered Section Component
|
|
138
|
-
function NumberedSection({
|
|
139
|
-
number,
|
|
140
|
-
title,
|
|
141
|
-
icon: Icon,
|
|
142
|
-
children
|
|
143
|
-
}: {
|
|
144
|
-
number: number;
|
|
145
|
-
title: string;
|
|
146
|
-
icon: React.ComponentType<{ className?: string }>;
|
|
147
|
-
children: React.ReactNode;
|
|
148
|
-
}) {
|
|
149
|
-
return (
|
|
150
|
-
<section id={`section-${number}`} className="scroll-mt-4">
|
|
151
|
-
<h2 className="text-xl font-semibold mb-4 flex items-center gap-3">
|
|
152
|
-
<span className="w-8 h-8 rounded-full bg-[var(--color-primary-600)] text-white flex items-center justify-center text-sm font-bold">
|
|
153
|
-
{number}
|
|
154
|
-
</span>
|
|
155
|
-
<Icon className="w-5 h-5 text-[var(--color-primary-600)]" />
|
|
156
|
-
{title}
|
|
157
|
-
</h2>
|
|
158
|
-
<div className="card p-6">
|
|
159
|
-
{children}
|
|
160
|
-
</div>
|
|
161
|
-
</section>
|
|
162
|
-
);
|
|
163
|
-
}
|
|
164
|
-
|
|
165
|
-
export function {ModuleName}DocPage() {
|
|
166
|
-
const { t } = useTranslation('docs');
|
|
167
|
-
|
|
168
|
-
return (
|
|
169
|
-
<div className="space-y-8">
|
|
170
|
-
{/* Breadcrumb */}
|
|
171
|
-
<nav className="flex items-center gap-2 text-sm text-[var(--text-secondary)]">
|
|
172
|
-
<Link to="/docs" className="hover:text-[var(--color-primary-600)]">
|
|
173
|
-
{t('breadcrumb.docs')}
|
|
174
|
-
</Link>
|
|
175
|
-
<span>/</span>
|
|
176
|
-
<Link to={`/docs/${docData.applicationName.toLowerCase()}`} className="hover:text-[var(--color-primary-600)]">
|
|
177
|
-
{t(`apps.${docData.applicationName.toLowerCase()}.name`)}
|
|
178
|
-
</Link>
|
|
179
|
-
<span>/</span>
|
|
180
|
-
<span>{t(`modules.${docData.moduleName.toLowerCase()}.name`)}</span>
|
|
181
|
-
</nav>
|
|
182
|
-
|
|
183
|
-
{/* Header */}
|
|
184
|
-
<header>
|
|
185
|
-
<div className="flex items-center gap-2 mb-2">
|
|
186
|
-
<span className="px-2 py-0.5 rounded bg-[var(--color-primary-600)]/10 text-[var(--color-primary-600)] text-xs font-medium">
|
|
187
|
-
{docData.featureId}
|
|
188
|
-
</span>
|
|
189
|
-
<span className="px-2 py-0.5 rounded bg-green-500/10 text-green-600 text-xs font-medium">
|
|
190
|
-
v{docData.version}
|
|
191
|
-
</span>
|
|
192
|
-
</div>
|
|
193
|
-
<h1 className="text-3xl font-bold mb-4 flex items-center gap-3">
|
|
194
|
-
<FileText className="w-8 h-8 text-[var(--color-primary-600)]" />
|
|
195
|
-
{t(`modules.${docData.moduleName.toLowerCase()}.title`)}
|
|
196
|
-
</h1>
|
|
197
|
-
<p className="text-lg text-[var(--text-secondary)]">
|
|
198
|
-
{t(`modules.${docData.moduleName.toLowerCase()}.subtitle`)}
|
|
199
|
-
</p>
|
|
200
|
-
</header>
|
|
201
|
-
|
|
202
|
-
{/* Table of Contents */}
|
|
203
|
-
<div className="card p-4 bg-[var(--bg-secondary)]">
|
|
204
|
-
<h2 className="font-semibold mb-3 flex items-center gap-2">
|
|
205
|
-
<List className="w-4 h-4" />
|
|
206
|
-
{t('common.tableOfContents')}
|
|
207
|
-
</h2>
|
|
208
|
-
<nav className="grid grid-cols-2 md:grid-cols-3 gap-2">
|
|
209
|
-
{['overview', 'useCases', 'businessRules', 'permissions', 'wireframes', 'api'].map((section, idx) => (
|
|
210
|
-
<a
|
|
211
|
-
key={section}
|
|
212
|
-
href={`#section-${idx + 1}`}
|
|
213
|
-
className="flex items-center gap-2 p-2 rounded hover:bg-[var(--bg-tertiary)] text-sm"
|
|
214
|
-
>
|
|
215
|
-
<ChevronRight className="w-4 h-4 text-[var(--color-primary-600)]" />
|
|
216
|
-
{t(`sections.${section}`)}
|
|
217
|
-
</a>
|
|
218
|
-
))}
|
|
219
|
-
</nav>
|
|
220
|
-
</div>
|
|
221
|
-
|
|
222
|
-
{/* Section 1: Overview */}
|
|
223
|
-
<NumberedSection number={1} title={t('sections.overview')} icon={Layout}>
|
|
224
|
-
<p className="text-[var(--text-secondary)] mb-4">
|
|
225
|
-
{t(`modules.${docData.moduleName.toLowerCase()}.overview`)}
|
|
226
|
-
</p>
|
|
227
|
-
<div className="grid grid-cols-2 md:grid-cols-4 gap-4 mt-4">
|
|
228
|
-
<div className="p-4 rounded-lg bg-[var(--bg-secondary)] text-center">
|
|
229
|
-
<div className="text-2xl font-bold text-[var(--color-primary-600)]">
|
|
230
|
-
{docData.useCases.length}
|
|
231
|
-
</div>
|
|
232
|
-
<div className="text-sm text-[var(--text-secondary)]">{t('stats.useCases')}</div>
|
|
233
|
-
</div>
|
|
234
|
-
<div className="p-4 rounded-lg bg-[var(--bg-secondary)] text-center">
|
|
235
|
-
<div className="text-2xl font-bold text-[var(--color-primary-600)]">
|
|
236
|
-
{docData.businessRules.length}
|
|
237
|
-
</div>
|
|
238
|
-
<div className="text-sm text-[var(--text-secondary)]">{t('stats.businessRules')}</div>
|
|
239
|
-
</div>
|
|
240
|
-
<div className="p-4 rounded-lg bg-[var(--bg-secondary)] text-center">
|
|
241
|
-
<div className="text-2xl font-bold text-[var(--color-primary-600)]">
|
|
242
|
-
{docData.permissions.length}
|
|
243
|
-
</div>
|
|
244
|
-
<div className="text-sm text-[var(--text-secondary)]">{t('stats.permissions')}</div>
|
|
245
|
-
</div>
|
|
246
|
-
</div>
|
|
247
|
-
</NumberedSection>
|
|
248
|
-
|
|
249
|
-
{/* Section 2: Use Cases */}
|
|
250
|
-
<NumberedSection number={2} title={t('sections.useCases')} icon={Users}>
|
|
251
|
-
<div className="space-y-4">
|
|
252
|
-
{docData.useCases.map((uc) => (
|
|
253
|
-
<div key={uc.id} className="border border-[var(--border-color)] rounded-lg p-4">
|
|
254
|
-
<div className="flex items-center justify-between mb-2">
|
|
255
|
-
<h3 className="font-semibold flex items-center gap-2">
|
|
256
|
-
<span className="px-2 py-0.5 rounded bg-[var(--color-primary-600)]/10 text-[var(--color-primary-600)] text-xs font-mono">
|
|
257
|
-
{uc.id}
|
|
258
|
-
</span>
|
|
259
|
-
{uc.name}
|
|
260
|
-
</h3>
|
|
261
|
-
<span className="text-sm text-[var(--text-secondary)]">
|
|
262
|
-
{t('labels.actor')}: {uc.actor}
|
|
263
|
-
</span>
|
|
264
|
-
</div>
|
|
265
|
-
<p className="text-sm text-[var(--text-secondary)] mb-2">{uc.description}</p>
|
|
266
|
-
<div className="flex items-center gap-2 text-xs">
|
|
267
|
-
<Shield className="w-3 h-3 text-amber-500" />
|
|
268
|
-
<code className="bg-[var(--bg-secondary)] px-2 py-0.5 rounded">{uc.permission}</code>
|
|
269
|
-
</div>
|
|
270
|
-
</div>
|
|
271
|
-
))}
|
|
272
|
-
</div>
|
|
273
|
-
</NumberedSection>
|
|
274
|
-
|
|
275
|
-
{/* Section 3: Business Rules */}
|
|
276
|
-
<NumberedSection number={3} title={t('sections.businessRules')} icon={CheckCircle}>
|
|
277
|
-
<div className="overflow-x-auto">
|
|
278
|
-
<table className="w-full text-sm">
|
|
279
|
-
<thead>
|
|
280
|
-
<tr className="bg-[var(--bg-secondary)]">
|
|
281
|
-
<th className="text-left py-2 px-3 rounded-tl-lg">ID</th>
|
|
282
|
-
<th className="text-left py-2 px-3">{t('labels.rule')}</th>
|
|
283
|
-
<th className="text-left py-2 px-3">{t('labels.category')}</th>
|
|
284
|
-
<th className="text-left py-2 px-3 rounded-tr-lg">{t('labels.priority')}</th>
|
|
285
|
-
</tr>
|
|
286
|
-
</thead>
|
|
287
|
-
<tbody>
|
|
288
|
-
{docData.businessRules.map((br, idx) => (
|
|
289
|
-
<tr key={br.id} className={idx % 2 === 1 ? 'bg-[var(--bg-secondary)]/50' : ''}>
|
|
290
|
-
<td className="py-2 px-3 font-mono text-[var(--color-primary-600)]">{br.id}</td>
|
|
291
|
-
<td className="py-2 px-3">{br.rule}</td>
|
|
292
|
-
<td className="py-2 px-3 text-[var(--text-secondary)]">{br.category}</td>
|
|
293
|
-
<td className="py-2 px-3"><PriorityBadge priority={br.priority} /></td>
|
|
294
|
-
</tr>
|
|
295
|
-
))}
|
|
296
|
-
</tbody>
|
|
297
|
-
</table>
|
|
298
|
-
</div>
|
|
299
|
-
</NumberedSection>
|
|
300
|
-
|
|
301
|
-
{/* Section 4: Permissions */}
|
|
302
|
-
<NumberedSection number={4} title={t('sections.permissions')} icon={Shield}>
|
|
303
|
-
<div className="space-y-3">
|
|
304
|
-
{docData.permissions.map((perm) => (
|
|
305
|
-
<div key={perm.path} className="flex items-center justify-between p-3 rounded-lg bg-[var(--bg-secondary)]">
|
|
306
|
-
<div>
|
|
307
|
-
<code className="text-sm font-mono text-[var(--color-primary-600)]">{perm.path}</code>
|
|
308
|
-
<p className="text-sm text-[var(--text-secondary)] mt-1">{perm.description}</p>
|
|
309
|
-
</div>
|
|
310
|
-
<div className="flex gap-1">
|
|
311
|
-
{perm.roles.map((role) => (
|
|
312
|
-
<span key={role} className="px-2 py-0.5 rounded bg-[var(--bg-tertiary)] text-xs">
|
|
313
|
-
{role}
|
|
314
|
-
</span>
|
|
315
|
-
))}
|
|
316
|
-
</div>
|
|
317
|
-
</div>
|
|
318
|
-
))}
|
|
319
|
-
</div>
|
|
320
|
-
|
|
321
|
-
{/* Permission Warning */}
|
|
322
|
-
<div className="mt-4 p-4 rounded-lg bg-amber-500/10 border border-amber-500/20 flex items-start gap-3">
|
|
323
|
-
<AlertTriangle className="w-5 h-5 text-amber-600 flex-shrink-0 mt-0.5" />
|
|
324
|
-
<div>
|
|
325
|
-
<div className="font-medium text-amber-600">{t('warnings.permissionCheck')}</div>
|
|
326
|
-
<p className="text-sm text-[var(--text-secondary)]">
|
|
327
|
-
{t('warnings.permissionCheckDescription')}
|
|
328
|
-
</p>
|
|
329
|
-
</div>
|
|
330
|
-
</div>
|
|
331
|
-
</NumberedSection>
|
|
332
|
-
|
|
333
|
-
{/* Section 5: Wireframes */}
|
|
334
|
-
<NumberedSection number={5} title={t('sections.wireframes')} icon={Layout}>
|
|
335
|
-
<div className="border-2 border-dashed border-[var(--border-color)] rounded-lg p-6">
|
|
336
|
-
<div className="text-center text-sm text-[var(--text-tertiary)] mb-4">
|
|
337
|
-
{t('common.wireframePreview')}
|
|
338
|
-
</div>
|
|
339
|
-
{/* Simplified wireframe */}
|
|
340
|
-
<div className="space-y-4">
|
|
341
|
-
<div className="h-12 bg-[var(--bg-secondary)] rounded flex items-center px-4 justify-between">
|
|
342
|
-
<span className="text-sm">[Header + Navigation]</span>
|
|
343
|
-
<span className="text-sm">[User Menu]</span>
|
|
344
|
-
</div>
|
|
345
|
-
<div className="grid grid-cols-4 gap-4">
|
|
346
|
-
<div className="col-span-1 h-64 bg-[var(--bg-secondary)] rounded p-4">
|
|
347
|
-
<span className="text-sm">[Filters]</span>
|
|
348
|
-
</div>
|
|
349
|
-
<div className="col-span-3 h-64 bg-[var(--bg-secondary)] rounded p-4">
|
|
350
|
-
<span className="text-sm">[Data Table]</span>
|
|
351
|
-
</div>
|
|
352
|
-
</div>
|
|
353
|
-
</div>
|
|
354
|
-
</div>
|
|
355
|
-
</NumberedSection>
|
|
356
|
-
|
|
357
|
-
{/* Section 6: API Endpoints */}
|
|
358
|
-
<NumberedSection number={6} title={t('sections.api')} icon={Database}>
|
|
359
|
-
<div className="overflow-x-auto">
|
|
360
|
-
<table className="w-full text-sm font-mono">
|
|
361
|
-
<thead>
|
|
362
|
-
<tr className="bg-[var(--bg-secondary)]">
|
|
363
|
-
<th className="text-left py-2 px-3 rounded-tl-lg">Method</th>
|
|
364
|
-
<th className="text-left py-2 px-3">Endpoint</th>
|
|
365
|
-
<th className="text-left py-2 px-3 rounded-tr-lg">Permission</th>
|
|
366
|
-
</tr>
|
|
367
|
-
</thead>
|
|
368
|
-
<tbody>
|
|
369
|
-
<tr>
|
|
370
|
-
<td className="py-2 px-3"><span className="px-2 py-0.5 rounded bg-green-500/10 text-green-600">GET</span></td>
|
|
371
|
-
<td className="py-2 px-3">/api/{'{module}'}</td>
|
|
372
|
-
<td className="py-2 px-3 text-[var(--text-secondary)]">.read</td>
|
|
373
|
-
</tr>
|
|
374
|
-
<tr className="bg-[var(--bg-secondary)]/50">
|
|
375
|
-
<td className="py-2 px-3"><span className="px-2 py-0.5 rounded bg-blue-500/10 text-blue-600">POST</span></td>
|
|
376
|
-
<td className="py-2 px-3">/api/{'{module}'}</td>
|
|
377
|
-
<td className="py-2 px-3 text-[var(--text-secondary)]">.create</td>
|
|
378
|
-
</tr>
|
|
379
|
-
<tr>
|
|
380
|
-
<td className="py-2 px-3"><span className="px-2 py-0.5 rounded bg-yellow-500/10 text-yellow-600">PUT</span></td>
|
|
381
|
-
<td className="py-2 px-3">/api/{'{module}'}/{'{id}'}</td>
|
|
382
|
-
<td className="py-2 px-3 text-[var(--text-secondary)]">.update</td>
|
|
383
|
-
</tr>
|
|
384
|
-
<tr className="bg-[var(--bg-secondary)]/50">
|
|
385
|
-
<td className="py-2 px-3"><span className="px-2 py-0.5 rounded bg-red-500/10 text-red-600">DELETE</span></td>
|
|
386
|
-
<td className="py-2 px-3">/api/{'{module}'}/{'{id}'}</td>
|
|
387
|
-
<td className="py-2 px-3 text-[var(--text-secondary)]">.delete</td>
|
|
388
|
-
</tr>
|
|
389
|
-
</tbody>
|
|
390
|
-
</table>
|
|
391
|
-
</div>
|
|
392
|
-
</NumberedSection>
|
|
393
|
-
|
|
394
|
-
{/* Navigation Footer */}
|
|
395
|
-
<div className="flex justify-between pt-6 border-t border-[var(--border-color)]">
|
|
396
|
-
<Link
|
|
397
|
-
to={`/docs/${docData.applicationName.toLowerCase()}`}
|
|
398
|
-
className="flex items-center gap-2 text-[var(--text-secondary)] hover:text-[var(--color-primary-600)]"
|
|
399
|
-
>
|
|
400
|
-
<ArrowRight className="w-4 h-4 rotate-180" />
|
|
401
|
-
{t('nav.backToApp')}
|
|
402
|
-
</Link>
|
|
403
|
-
<Link
|
|
404
|
-
to="/docs"
|
|
405
|
-
className="flex items-center gap-2 text-[var(--color-primary-600)]"
|
|
406
|
-
>
|
|
407
|
-
{t('nav.allModules')}
|
|
408
|
-
<ArrowRight className="w-4 h-4" />
|
|
409
|
-
</Link>
|
|
410
|
-
</div>
|
|
411
|
-
</div>
|
|
412
|
-
);
|
|
413
|
-
}
|
|
414
|
-
```
|
|
415
|
-
|
|
416
|
-
---
|
|
417
|
-
|
|
418
|
-
## Template i18n docs-business.json
|
|
419
|
-
|
|
420
|
-
```json
|
|
421
|
-
{
|
|
422
|
-
"breadcrumb": {
|
|
423
|
-
"docs": "Documentation",
|
|
424
|
-
"business": "Business"
|
|
425
|
-
},
|
|
426
|
-
"common": {
|
|
427
|
-
"tableOfContents": "Table of Contents",
|
|
428
|
-
"wireframePreview": "Wireframe Preview"
|
|
429
|
-
},
|
|
430
|
-
"sections": {
|
|
431
|
-
"overview": "Overview",
|
|
432
|
-
"useCases": "Use Cases",
|
|
433
|
-
"businessRules": "Business Rules",
|
|
434
|
-
"permissions": "Permissions",
|
|
435
|
-
"wireframes": "Wireframes",
|
|
436
|
-
"api": "API Endpoints"
|
|
437
|
-
},
|
|
438
|
-
"labels": {
|
|
439
|
-
"actor": "Actor",
|
|
440
|
-
"rule": "Rule",
|
|
441
|
-
"category": "Category",
|
|
442
|
-
"priority": "Priority"
|
|
443
|
-
},
|
|
444
|
-
"stats": {
|
|
445
|
-
"useCases": "Use Cases",
|
|
446
|
-
"businessRules": "Business Rules",
|
|
447
|
-
"permissions": "Permissions"
|
|
448
|
-
},
|
|
449
|
-
"warnings": {
|
|
450
|
-
"permissionCheck": "Permission Check Required",
|
|
451
|
-
"permissionCheckDescription": "Ensure all permissions are registered in PermissionConfiguration.cs before deployment."
|
|
452
|
-
},
|
|
453
|
-
"nav": {
|
|
454
|
-
"backToApp": "Back to Application",
|
|
455
|
-
"allModules": "All Modules"
|
|
456
|
-
},
|
|
457
|
-
"apps": {
|
|
458
|
-
"{app}": {
|
|
459
|
-
"name": "{Application Name}",
|
|
460
|
-
"description": "{Application description}"
|
|
461
|
-
}
|
|
462
|
-
},
|
|
463
|
-
"modules": {
|
|
464
|
-
"{module}": {
|
|
465
|
-
"name": "{Module Name}",
|
|
466
|
-
"title": "{Module Title}",
|
|
467
|
-
"subtitle": "{Module subtitle description}",
|
|
468
|
-
"overview": "{Detailed overview of the module functionality}"
|
|
469
|
-
}
|
|
470
|
-
}
|
|
471
|
-
}
|
|
472
|
-
```
|
|
473
|
-
|
|
474
|
-
---
|
|
475
|
-
|
|
476
|
-
## Template Index Application
|
|
477
|
-
|
|
478
|
-
```tsx
|
|
479
|
-
// web/smartstack-web/src/pages/docs/{app}/index.tsx
|
|
480
|
-
|
|
481
|
-
import { Link } from 'react-router-dom';
|
|
482
|
-
import { useTranslation } from 'react-i18next';
|
|
483
|
-
import { Folder, FileText, ChevronRight } from 'lucide-react';
|
|
484
|
-
|
|
485
|
-
interface ModuleLink {
|
|
486
|
-
id: string;
|
|
487
|
-
name: string;
|
|
488
|
-
description: string;
|
|
489
|
-
features: number;
|
|
490
|
-
path: string;
|
|
491
|
-
}
|
|
492
|
-
|
|
493
|
-
const modules: ModuleLink[] = [
|
|
494
|
-
{
|
|
495
|
-
id: '{module}',
|
|
496
|
-
name: '{Module Name}',
|
|
497
|
-
description: '{Module description}',
|
|
498
|
-
features: 3,
|
|
499
|
-
path: '/docs/{app}/{module}'
|
|
500
|
-
}
|
|
501
|
-
];
|
|
502
|
-
|
|
503
|
-
export function {App}DocsIndexPage() {
|
|
504
|
-
const { t } = useTranslation('docs-business');
|
|
505
|
-
|
|
506
|
-
return (
|
|
507
|
-
<div className="space-y-8">
|
|
508
|
-
{/* Breadcrumb */}
|
|
509
|
-
<nav className="flex items-center gap-2 text-sm text-[var(--text-secondary)]">
|
|
510
|
-
<Link to="/docs">{t('breadcrumb.docs')}</Link>
|
|
511
|
-
<span>/</span>
|
|
512
|
-
<span>{t('apps.{app}.name')}</span>
|
|
513
|
-
</nav>
|
|
514
|
-
|
|
515
|
-
{/* Header */}
|
|
516
|
-
<header>
|
|
517
|
-
<h1 className="text-3xl font-bold mb-4 flex items-center gap-3">
|
|
518
|
-
<Folder className="w-8 h-8 text-[var(--color-primary-600)]" />
|
|
519
|
-
{t('apps.{app}.name')}
|
|
520
|
-
</h1>
|
|
521
|
-
<p className="text-lg text-[var(--text-secondary)]">
|
|
522
|
-
{t('apps.{app}.description')}
|
|
523
|
-
</p>
|
|
524
|
-
</header>
|
|
525
|
-
|
|
526
|
-
{/* Modules list */}
|
|
527
|
-
<section>
|
|
528
|
-
<h2 className="text-xl font-semibold mb-4">{t('common.modules')}</h2>
|
|
529
|
-
<div className="grid gap-4">
|
|
530
|
-
{modules.map((module) => (
|
|
531
|
-
<Link
|
|
532
|
-
key={module.id}
|
|
533
|
-
to={module.path}
|
|
534
|
-
className="card p-4 hover:border-[var(--color-primary-600)] transition-colors group"
|
|
535
|
-
>
|
|
536
|
-
<div className="flex items-center justify-between">
|
|
537
|
-
<div className="flex items-center gap-3">
|
|
538
|
-
<FileText className="w-6 h-6 text-[var(--color-primary-600)]" />
|
|
539
|
-
<div>
|
|
540
|
-
<h3 className="font-semibold group-hover:text-[var(--color-primary-600)]">
|
|
541
|
-
{module.name}
|
|
542
|
-
</h3>
|
|
543
|
-
<p className="text-sm text-[var(--text-secondary)]">
|
|
544
|
-
{module.description}
|
|
545
|
-
</p>
|
|
546
|
-
</div>
|
|
547
|
-
</div>
|
|
548
|
-
<div className="flex items-center gap-4">
|
|
549
|
-
<span className="text-sm text-[var(--text-secondary)]">
|
|
550
|
-
{module.features} features
|
|
551
|
-
</span>
|
|
552
|
-
<ChevronRight className="w-5 h-5 text-[var(--text-tertiary)] group-hover:text-[var(--color-primary-600)]" />
|
|
553
|
-
</div>
|
|
554
|
-
</div>
|
|
555
|
-
</Link>
|
|
556
|
-
))}
|
|
557
|
-
</div>
|
|
558
|
-
</section>
|
|
559
|
-
</div>
|
|
560
|
-
);
|
|
561
|
-
}
|
|
562
|
-
```
|
|
563
|
-
|
|
564
|
-
---
|
|
565
|
-
|
|
566
|
-
## Generation Checklist
|
|
567
|
-
|
|
568
|
-
When generating documentation:
|
|
569
|
-
|
|
570
|
-
- [ ] Use Context7 for current React patterns
|
|
571
|
-
- [ ] Generate `DocPage.tsx` with module documentation data
|
|
572
|
-
- [ ] Create/update `docs-business.json` (4 languages)
|
|
573
|
-
- [ ] Add route in `App.tsx`
|
|
574
|
-
- [ ] Update parent index if new module
|
|
1
|
+
# Templates React - Documentation Module
|
|
2
|
+
|
|
3
|
+
> **Usage:** Templates for generating HTML (React) documentation of module specifications
|
|
4
|
+
> **Output:** `web/smartstack-web/src/pages/docs/{app}/{module}/`
|
|
5
|
+
> **Context7:** Use for up-to-date React code generation
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## CONTEXT7 RULE (MANDATORY)
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
╔══════════════════════════════════════════════════════════════════════════════╗
|
|
13
|
+
║ REACT GENERATION WITH CONTEXT7 ║
|
|
14
|
+
╠══════════════════════════════════════════════════════════════════════════════╣
|
|
15
|
+
║ ║
|
|
16
|
+
║ ALWAYS use Context7 for React component generation: ║
|
|
17
|
+
║ ║
|
|
18
|
+
║ Prompt pattern: ║
|
|
19
|
+
║ "use context7 with /facebook/react and /i18next/react-i18next ║
|
|
20
|
+
║ to generate {component} following SmartStack patterns" ║
|
|
21
|
+
║ ║
|
|
22
|
+
║ Libraries to reference: ║
|
|
23
|
+
║ • /facebook/react - React 19 patterns ║
|
|
24
|
+
║ • /i18next/react-i18next - Internationalization ║
|
|
25
|
+
║ • /remix-run/react-router - React Router v7 ║
|
|
26
|
+
║ • /lucide-icons/lucide-react - Icons ║
|
|
27
|
+
║ ║
|
|
28
|
+
╚══════════════════════════════════════════════════════════════════════════════╝
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## Template DocPage.tsx
|
|
34
|
+
|
|
35
|
+
```tsx
|
|
36
|
+
// web/smartstack-web/src/pages/docs/{app}/{module}/DocPage.tsx
|
|
37
|
+
// GENERATE WITH: use context7 with /facebook/react
|
|
38
|
+
|
|
39
|
+
import { Link } from 'react-router-dom';
|
|
40
|
+
import { useTranslation } from 'react-i18next';
|
|
41
|
+
import {
|
|
42
|
+
FileText,
|
|
43
|
+
Users,
|
|
44
|
+
Shield,
|
|
45
|
+
CheckCircle,
|
|
46
|
+
AlertTriangle,
|
|
47
|
+
ChevronRight,
|
|
48
|
+
ArrowRight,
|
|
49
|
+
List,
|
|
50
|
+
Layout,
|
|
51
|
+
Database
|
|
52
|
+
} from 'lucide-react';
|
|
53
|
+
|
|
54
|
+
// Types for documentation data
|
|
55
|
+
interface UseCase {
|
|
56
|
+
id: string;
|
|
57
|
+
name: string;
|
|
58
|
+
actor: string;
|
|
59
|
+
permission: string;
|
|
60
|
+
description: string;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
interface BusinessRule {
|
|
64
|
+
id: string;
|
|
65
|
+
rule: string;
|
|
66
|
+
category: string;
|
|
67
|
+
priority: 'Must' | 'Should' | 'Could';
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
interface Permission {
|
|
71
|
+
path: string;
|
|
72
|
+
description: string;
|
|
73
|
+
roles: string[];
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
interface DocData {
|
|
77
|
+
featureId: string;
|
|
78
|
+
moduleName: string;
|
|
79
|
+
applicationName: string;
|
|
80
|
+
version: string;
|
|
81
|
+
useCases: UseCase[];
|
|
82
|
+
businessRules: BusinessRule[];
|
|
83
|
+
permissions: Permission[];
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
// Data loaded from feature.json (to be generated dynamically)
|
|
87
|
+
const docData: DocData = {
|
|
88
|
+
featureId: 'FEAT-XXX',
|
|
89
|
+
moduleName: '{ModuleName}',
|
|
90
|
+
applicationName: '{ApplicationName}',
|
|
91
|
+
version: '1.0',
|
|
92
|
+
useCases: [
|
|
93
|
+
{
|
|
94
|
+
id: 'UC-001',
|
|
95
|
+
name: '{Use Case Name}',
|
|
96
|
+
actor: '{Actor}',
|
|
97
|
+
permission: '{app}.{module}.{action}',
|
|
98
|
+
description: '{Description}'
|
|
99
|
+
}
|
|
100
|
+
],
|
|
101
|
+
businessRules: [
|
|
102
|
+
{
|
|
103
|
+
id: 'BR-001',
|
|
104
|
+
rule: '{Business Rule Description}',
|
|
105
|
+
category: 'Validation',
|
|
106
|
+
priority: 'Must'
|
|
107
|
+
}
|
|
108
|
+
],
|
|
109
|
+
permissions: [
|
|
110
|
+
{
|
|
111
|
+
path: '{app}.{module}.read',
|
|
112
|
+
description: 'View {module} data',
|
|
113
|
+
roles: ['Admin', 'Manager', 'User', 'ReadOnly']
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
path: '{app}.{module}.create',
|
|
117
|
+
description: 'Create new {module}',
|
|
118
|
+
roles: ['Admin', 'Manager']
|
|
119
|
+
}
|
|
120
|
+
]
|
|
121
|
+
};
|
|
122
|
+
|
|
123
|
+
// Priority Badge Component
|
|
124
|
+
function PriorityBadge({ priority }: { priority: string }) {
|
|
125
|
+
const colors = {
|
|
126
|
+
Must: 'bg-red-500/10 text-red-600',
|
|
127
|
+
Should: 'bg-yellow-500/10 text-yellow-600',
|
|
128
|
+
Could: 'bg-blue-500/10 text-blue-600'
|
|
129
|
+
};
|
|
130
|
+
return (
|
|
131
|
+
<span className={`px-2 py-0.5 rounded text-xs font-medium ${colors[priority as keyof typeof colors] || 'bg-gray-500/10 text-gray-600'}`}>
|
|
132
|
+
{priority}
|
|
133
|
+
</span>
|
|
134
|
+
);
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
// Numbered Section Component
|
|
138
|
+
function NumberedSection({
|
|
139
|
+
number,
|
|
140
|
+
title,
|
|
141
|
+
icon: Icon,
|
|
142
|
+
children
|
|
143
|
+
}: {
|
|
144
|
+
number: number;
|
|
145
|
+
title: string;
|
|
146
|
+
icon: React.ComponentType<{ className?: string }>;
|
|
147
|
+
children: React.ReactNode;
|
|
148
|
+
}) {
|
|
149
|
+
return (
|
|
150
|
+
<section id={`section-${number}`} className="scroll-mt-4">
|
|
151
|
+
<h2 className="text-xl font-semibold mb-4 flex items-center gap-3">
|
|
152
|
+
<span className="w-8 h-8 rounded-full bg-[var(--color-primary-600)] text-white flex items-center justify-center text-sm font-bold">
|
|
153
|
+
{number}
|
|
154
|
+
</span>
|
|
155
|
+
<Icon className="w-5 h-5 text-[var(--color-primary-600)]" />
|
|
156
|
+
{title}
|
|
157
|
+
</h2>
|
|
158
|
+
<div className="card p-6">
|
|
159
|
+
{children}
|
|
160
|
+
</div>
|
|
161
|
+
</section>
|
|
162
|
+
);
|
|
163
|
+
}
|
|
164
|
+
|
|
165
|
+
export function {ModuleName}DocPage() {
|
|
166
|
+
const { t } = useTranslation('docs');
|
|
167
|
+
|
|
168
|
+
return (
|
|
169
|
+
<div className="space-y-8">
|
|
170
|
+
{/* Breadcrumb */}
|
|
171
|
+
<nav className="flex items-center gap-2 text-sm text-[var(--text-secondary)]">
|
|
172
|
+
<Link to="/docs" className="hover:text-[var(--color-primary-600)]">
|
|
173
|
+
{t('breadcrumb.docs')}
|
|
174
|
+
</Link>
|
|
175
|
+
<span>/</span>
|
|
176
|
+
<Link to={`/docs/${docData.applicationName.toLowerCase()}`} className="hover:text-[var(--color-primary-600)]">
|
|
177
|
+
{t(`apps.${docData.applicationName.toLowerCase()}.name`)}
|
|
178
|
+
</Link>
|
|
179
|
+
<span>/</span>
|
|
180
|
+
<span>{t(`modules.${docData.moduleName.toLowerCase()}.name`)}</span>
|
|
181
|
+
</nav>
|
|
182
|
+
|
|
183
|
+
{/* Header */}
|
|
184
|
+
<header>
|
|
185
|
+
<div className="flex items-center gap-2 mb-2">
|
|
186
|
+
<span className="px-2 py-0.5 rounded bg-[var(--color-primary-600)]/10 text-[var(--color-primary-600)] text-xs font-medium">
|
|
187
|
+
{docData.featureId}
|
|
188
|
+
</span>
|
|
189
|
+
<span className="px-2 py-0.5 rounded bg-green-500/10 text-green-600 text-xs font-medium">
|
|
190
|
+
v{docData.version}
|
|
191
|
+
</span>
|
|
192
|
+
</div>
|
|
193
|
+
<h1 className="text-3xl font-bold mb-4 flex items-center gap-3">
|
|
194
|
+
<FileText className="w-8 h-8 text-[var(--color-primary-600)]" />
|
|
195
|
+
{t(`modules.${docData.moduleName.toLowerCase()}.title`)}
|
|
196
|
+
</h1>
|
|
197
|
+
<p className="text-lg text-[var(--text-secondary)]">
|
|
198
|
+
{t(`modules.${docData.moduleName.toLowerCase()}.subtitle`)}
|
|
199
|
+
</p>
|
|
200
|
+
</header>
|
|
201
|
+
|
|
202
|
+
{/* Table of Contents */}
|
|
203
|
+
<div className="card p-4 bg-[var(--bg-secondary)]">
|
|
204
|
+
<h2 className="font-semibold mb-3 flex items-center gap-2">
|
|
205
|
+
<List className="w-4 h-4" />
|
|
206
|
+
{t('common.tableOfContents')}
|
|
207
|
+
</h2>
|
|
208
|
+
<nav className="grid grid-cols-2 md:grid-cols-3 gap-2">
|
|
209
|
+
{['overview', 'useCases', 'businessRules', 'permissions', 'wireframes', 'api'].map((section, idx) => (
|
|
210
|
+
<a
|
|
211
|
+
key={section}
|
|
212
|
+
href={`#section-${idx + 1}`}
|
|
213
|
+
className="flex items-center gap-2 p-2 rounded hover:bg-[var(--bg-tertiary)] text-sm"
|
|
214
|
+
>
|
|
215
|
+
<ChevronRight className="w-4 h-4 text-[var(--color-primary-600)]" />
|
|
216
|
+
{t(`sections.${section}`)}
|
|
217
|
+
</a>
|
|
218
|
+
))}
|
|
219
|
+
</nav>
|
|
220
|
+
</div>
|
|
221
|
+
|
|
222
|
+
{/* Section 1: Overview */}
|
|
223
|
+
<NumberedSection number={1} title={t('sections.overview')} icon={Layout}>
|
|
224
|
+
<p className="text-[var(--text-secondary)] mb-4">
|
|
225
|
+
{t(`modules.${docData.moduleName.toLowerCase()}.overview`)}
|
|
226
|
+
</p>
|
|
227
|
+
<div className="grid grid-cols-2 md:grid-cols-4 gap-4 mt-4">
|
|
228
|
+
<div className="p-4 rounded-lg bg-[var(--bg-secondary)] text-center">
|
|
229
|
+
<div className="text-2xl font-bold text-[var(--color-primary-600)]">
|
|
230
|
+
{docData.useCases.length}
|
|
231
|
+
</div>
|
|
232
|
+
<div className="text-sm text-[var(--text-secondary)]">{t('stats.useCases')}</div>
|
|
233
|
+
</div>
|
|
234
|
+
<div className="p-4 rounded-lg bg-[var(--bg-secondary)] text-center">
|
|
235
|
+
<div className="text-2xl font-bold text-[var(--color-primary-600)]">
|
|
236
|
+
{docData.businessRules.length}
|
|
237
|
+
</div>
|
|
238
|
+
<div className="text-sm text-[var(--text-secondary)]">{t('stats.businessRules')}</div>
|
|
239
|
+
</div>
|
|
240
|
+
<div className="p-4 rounded-lg bg-[var(--bg-secondary)] text-center">
|
|
241
|
+
<div className="text-2xl font-bold text-[var(--color-primary-600)]">
|
|
242
|
+
{docData.permissions.length}
|
|
243
|
+
</div>
|
|
244
|
+
<div className="text-sm text-[var(--text-secondary)]">{t('stats.permissions')}</div>
|
|
245
|
+
</div>
|
|
246
|
+
</div>
|
|
247
|
+
</NumberedSection>
|
|
248
|
+
|
|
249
|
+
{/* Section 2: Use Cases */}
|
|
250
|
+
<NumberedSection number={2} title={t('sections.useCases')} icon={Users}>
|
|
251
|
+
<div className="space-y-4">
|
|
252
|
+
{docData.useCases.map((uc) => (
|
|
253
|
+
<div key={uc.id} className="border border-[var(--border-color)] rounded-lg p-4">
|
|
254
|
+
<div className="flex items-center justify-between mb-2">
|
|
255
|
+
<h3 className="font-semibold flex items-center gap-2">
|
|
256
|
+
<span className="px-2 py-0.5 rounded bg-[var(--color-primary-600)]/10 text-[var(--color-primary-600)] text-xs font-mono">
|
|
257
|
+
{uc.id}
|
|
258
|
+
</span>
|
|
259
|
+
{uc.name}
|
|
260
|
+
</h3>
|
|
261
|
+
<span className="text-sm text-[var(--text-secondary)]">
|
|
262
|
+
{t('labels.actor')}: {uc.actor}
|
|
263
|
+
</span>
|
|
264
|
+
</div>
|
|
265
|
+
<p className="text-sm text-[var(--text-secondary)] mb-2">{uc.description}</p>
|
|
266
|
+
<div className="flex items-center gap-2 text-xs">
|
|
267
|
+
<Shield className="w-3 h-3 text-amber-500" />
|
|
268
|
+
<code className="bg-[var(--bg-secondary)] px-2 py-0.5 rounded">{uc.permission}</code>
|
|
269
|
+
</div>
|
|
270
|
+
</div>
|
|
271
|
+
))}
|
|
272
|
+
</div>
|
|
273
|
+
</NumberedSection>
|
|
274
|
+
|
|
275
|
+
{/* Section 3: Business Rules */}
|
|
276
|
+
<NumberedSection number={3} title={t('sections.businessRules')} icon={CheckCircle}>
|
|
277
|
+
<div className="overflow-x-auto">
|
|
278
|
+
<table className="w-full text-sm">
|
|
279
|
+
<thead>
|
|
280
|
+
<tr className="bg-[var(--bg-secondary)]">
|
|
281
|
+
<th className="text-left py-2 px-3 rounded-tl-lg">ID</th>
|
|
282
|
+
<th className="text-left py-2 px-3">{t('labels.rule')}</th>
|
|
283
|
+
<th className="text-left py-2 px-3">{t('labels.category')}</th>
|
|
284
|
+
<th className="text-left py-2 px-3 rounded-tr-lg">{t('labels.priority')}</th>
|
|
285
|
+
</tr>
|
|
286
|
+
</thead>
|
|
287
|
+
<tbody>
|
|
288
|
+
{docData.businessRules.map((br, idx) => (
|
|
289
|
+
<tr key={br.id} className={idx % 2 === 1 ? 'bg-[var(--bg-secondary)]/50' : ''}>
|
|
290
|
+
<td className="py-2 px-3 font-mono text-[var(--color-primary-600)]">{br.id}</td>
|
|
291
|
+
<td className="py-2 px-3">{br.rule}</td>
|
|
292
|
+
<td className="py-2 px-3 text-[var(--text-secondary)]">{br.category}</td>
|
|
293
|
+
<td className="py-2 px-3"><PriorityBadge priority={br.priority} /></td>
|
|
294
|
+
</tr>
|
|
295
|
+
))}
|
|
296
|
+
</tbody>
|
|
297
|
+
</table>
|
|
298
|
+
</div>
|
|
299
|
+
</NumberedSection>
|
|
300
|
+
|
|
301
|
+
{/* Section 4: Permissions */}
|
|
302
|
+
<NumberedSection number={4} title={t('sections.permissions')} icon={Shield}>
|
|
303
|
+
<div className="space-y-3">
|
|
304
|
+
{docData.permissions.map((perm) => (
|
|
305
|
+
<div key={perm.path} className="flex items-center justify-between p-3 rounded-lg bg-[var(--bg-secondary)]">
|
|
306
|
+
<div>
|
|
307
|
+
<code className="text-sm font-mono text-[var(--color-primary-600)]">{perm.path}</code>
|
|
308
|
+
<p className="text-sm text-[var(--text-secondary)] mt-1">{perm.description}</p>
|
|
309
|
+
</div>
|
|
310
|
+
<div className="flex gap-1">
|
|
311
|
+
{perm.roles.map((role) => (
|
|
312
|
+
<span key={role} className="px-2 py-0.5 rounded bg-[var(--bg-tertiary)] text-xs">
|
|
313
|
+
{role}
|
|
314
|
+
</span>
|
|
315
|
+
))}
|
|
316
|
+
</div>
|
|
317
|
+
</div>
|
|
318
|
+
))}
|
|
319
|
+
</div>
|
|
320
|
+
|
|
321
|
+
{/* Permission Warning */}
|
|
322
|
+
<div className="mt-4 p-4 rounded-lg bg-amber-500/10 border border-amber-500/20 flex items-start gap-3">
|
|
323
|
+
<AlertTriangle className="w-5 h-5 text-amber-600 flex-shrink-0 mt-0.5" />
|
|
324
|
+
<div>
|
|
325
|
+
<div className="font-medium text-amber-600">{t('warnings.permissionCheck')}</div>
|
|
326
|
+
<p className="text-sm text-[var(--text-secondary)]">
|
|
327
|
+
{t('warnings.permissionCheckDescription')}
|
|
328
|
+
</p>
|
|
329
|
+
</div>
|
|
330
|
+
</div>
|
|
331
|
+
</NumberedSection>
|
|
332
|
+
|
|
333
|
+
{/* Section 5: Wireframes */}
|
|
334
|
+
<NumberedSection number={5} title={t('sections.wireframes')} icon={Layout}>
|
|
335
|
+
<div className="border-2 border-dashed border-[var(--border-color)] rounded-lg p-6">
|
|
336
|
+
<div className="text-center text-sm text-[var(--text-tertiary)] mb-4">
|
|
337
|
+
{t('common.wireframePreview')}
|
|
338
|
+
</div>
|
|
339
|
+
{/* Simplified wireframe */}
|
|
340
|
+
<div className="space-y-4">
|
|
341
|
+
<div className="h-12 bg-[var(--bg-secondary)] rounded flex items-center px-4 justify-between">
|
|
342
|
+
<span className="text-sm">[Header + Navigation]</span>
|
|
343
|
+
<span className="text-sm">[User Menu]</span>
|
|
344
|
+
</div>
|
|
345
|
+
<div className="grid grid-cols-4 gap-4">
|
|
346
|
+
<div className="col-span-1 h-64 bg-[var(--bg-secondary)] rounded p-4">
|
|
347
|
+
<span className="text-sm">[Filters]</span>
|
|
348
|
+
</div>
|
|
349
|
+
<div className="col-span-3 h-64 bg-[var(--bg-secondary)] rounded p-4">
|
|
350
|
+
<span className="text-sm">[Data Table]</span>
|
|
351
|
+
</div>
|
|
352
|
+
</div>
|
|
353
|
+
</div>
|
|
354
|
+
</div>
|
|
355
|
+
</NumberedSection>
|
|
356
|
+
|
|
357
|
+
{/* Section 6: API Endpoints */}
|
|
358
|
+
<NumberedSection number={6} title={t('sections.api')} icon={Database}>
|
|
359
|
+
<div className="overflow-x-auto">
|
|
360
|
+
<table className="w-full text-sm font-mono">
|
|
361
|
+
<thead>
|
|
362
|
+
<tr className="bg-[var(--bg-secondary)]">
|
|
363
|
+
<th className="text-left py-2 px-3 rounded-tl-lg">Method</th>
|
|
364
|
+
<th className="text-left py-2 px-3">Endpoint</th>
|
|
365
|
+
<th className="text-left py-2 px-3 rounded-tr-lg">Permission</th>
|
|
366
|
+
</tr>
|
|
367
|
+
</thead>
|
|
368
|
+
<tbody>
|
|
369
|
+
<tr>
|
|
370
|
+
<td className="py-2 px-3"><span className="px-2 py-0.5 rounded bg-green-500/10 text-green-600">GET</span></td>
|
|
371
|
+
<td className="py-2 px-3">/api/{'{module}'}</td>
|
|
372
|
+
<td className="py-2 px-3 text-[var(--text-secondary)]">.read</td>
|
|
373
|
+
</tr>
|
|
374
|
+
<tr className="bg-[var(--bg-secondary)]/50">
|
|
375
|
+
<td className="py-2 px-3"><span className="px-2 py-0.5 rounded bg-blue-500/10 text-blue-600">POST</span></td>
|
|
376
|
+
<td className="py-2 px-3">/api/{'{module}'}</td>
|
|
377
|
+
<td className="py-2 px-3 text-[var(--text-secondary)]">.create</td>
|
|
378
|
+
</tr>
|
|
379
|
+
<tr>
|
|
380
|
+
<td className="py-2 px-3"><span className="px-2 py-0.5 rounded bg-yellow-500/10 text-yellow-600">PUT</span></td>
|
|
381
|
+
<td className="py-2 px-3">/api/{'{module}'}/{'{id}'}</td>
|
|
382
|
+
<td className="py-2 px-3 text-[var(--text-secondary)]">.update</td>
|
|
383
|
+
</tr>
|
|
384
|
+
<tr className="bg-[var(--bg-secondary)]/50">
|
|
385
|
+
<td className="py-2 px-3"><span className="px-2 py-0.5 rounded bg-red-500/10 text-red-600">DELETE</span></td>
|
|
386
|
+
<td className="py-2 px-3">/api/{'{module}'}/{'{id}'}</td>
|
|
387
|
+
<td className="py-2 px-3 text-[var(--text-secondary)]">.delete</td>
|
|
388
|
+
</tr>
|
|
389
|
+
</tbody>
|
|
390
|
+
</table>
|
|
391
|
+
</div>
|
|
392
|
+
</NumberedSection>
|
|
393
|
+
|
|
394
|
+
{/* Navigation Footer */}
|
|
395
|
+
<div className="flex justify-between pt-6 border-t border-[var(--border-color)]">
|
|
396
|
+
<Link
|
|
397
|
+
to={`/docs/${docData.applicationName.toLowerCase()}`}
|
|
398
|
+
className="flex items-center gap-2 text-[var(--text-secondary)] hover:text-[var(--color-primary-600)]"
|
|
399
|
+
>
|
|
400
|
+
<ArrowRight className="w-4 h-4 rotate-180" />
|
|
401
|
+
{t('nav.backToApp')}
|
|
402
|
+
</Link>
|
|
403
|
+
<Link
|
|
404
|
+
to="/docs"
|
|
405
|
+
className="flex items-center gap-2 text-[var(--color-primary-600)]"
|
|
406
|
+
>
|
|
407
|
+
{t('nav.allModules')}
|
|
408
|
+
<ArrowRight className="w-4 h-4" />
|
|
409
|
+
</Link>
|
|
410
|
+
</div>
|
|
411
|
+
</div>
|
|
412
|
+
);
|
|
413
|
+
}
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
---
|
|
417
|
+
|
|
418
|
+
## Template i18n docs-business.json
|
|
419
|
+
|
|
420
|
+
```json
|
|
421
|
+
{
|
|
422
|
+
"breadcrumb": {
|
|
423
|
+
"docs": "Documentation",
|
|
424
|
+
"business": "Business"
|
|
425
|
+
},
|
|
426
|
+
"common": {
|
|
427
|
+
"tableOfContents": "Table of Contents",
|
|
428
|
+
"wireframePreview": "Wireframe Preview"
|
|
429
|
+
},
|
|
430
|
+
"sections": {
|
|
431
|
+
"overview": "Overview",
|
|
432
|
+
"useCases": "Use Cases",
|
|
433
|
+
"businessRules": "Business Rules",
|
|
434
|
+
"permissions": "Permissions",
|
|
435
|
+
"wireframes": "Wireframes",
|
|
436
|
+
"api": "API Endpoints"
|
|
437
|
+
},
|
|
438
|
+
"labels": {
|
|
439
|
+
"actor": "Actor",
|
|
440
|
+
"rule": "Rule",
|
|
441
|
+
"category": "Category",
|
|
442
|
+
"priority": "Priority"
|
|
443
|
+
},
|
|
444
|
+
"stats": {
|
|
445
|
+
"useCases": "Use Cases",
|
|
446
|
+
"businessRules": "Business Rules",
|
|
447
|
+
"permissions": "Permissions"
|
|
448
|
+
},
|
|
449
|
+
"warnings": {
|
|
450
|
+
"permissionCheck": "Permission Check Required",
|
|
451
|
+
"permissionCheckDescription": "Ensure all permissions are registered in PermissionConfiguration.cs before deployment."
|
|
452
|
+
},
|
|
453
|
+
"nav": {
|
|
454
|
+
"backToApp": "Back to Application",
|
|
455
|
+
"allModules": "All Modules"
|
|
456
|
+
},
|
|
457
|
+
"apps": {
|
|
458
|
+
"{app}": {
|
|
459
|
+
"name": "{Application Name}",
|
|
460
|
+
"description": "{Application description}"
|
|
461
|
+
}
|
|
462
|
+
},
|
|
463
|
+
"modules": {
|
|
464
|
+
"{module}": {
|
|
465
|
+
"name": "{Module Name}",
|
|
466
|
+
"title": "{Module Title}",
|
|
467
|
+
"subtitle": "{Module subtitle description}",
|
|
468
|
+
"overview": "{Detailed overview of the module functionality}"
|
|
469
|
+
}
|
|
470
|
+
}
|
|
471
|
+
}
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
---
|
|
475
|
+
|
|
476
|
+
## Template Index Application
|
|
477
|
+
|
|
478
|
+
```tsx
|
|
479
|
+
// web/smartstack-web/src/pages/docs/{app}/index.tsx
|
|
480
|
+
|
|
481
|
+
import { Link } from 'react-router-dom';
|
|
482
|
+
import { useTranslation } from 'react-i18next';
|
|
483
|
+
import { Folder, FileText, ChevronRight } from 'lucide-react';
|
|
484
|
+
|
|
485
|
+
interface ModuleLink {
|
|
486
|
+
id: string;
|
|
487
|
+
name: string;
|
|
488
|
+
description: string;
|
|
489
|
+
features: number;
|
|
490
|
+
path: string;
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
const modules: ModuleLink[] = [
|
|
494
|
+
{
|
|
495
|
+
id: '{module}',
|
|
496
|
+
name: '{Module Name}',
|
|
497
|
+
description: '{Module description}',
|
|
498
|
+
features: 3,
|
|
499
|
+
path: '/docs/{app}/{module}'
|
|
500
|
+
}
|
|
501
|
+
];
|
|
502
|
+
|
|
503
|
+
export function {App}DocsIndexPage() {
|
|
504
|
+
const { t } = useTranslation('docs-business');
|
|
505
|
+
|
|
506
|
+
return (
|
|
507
|
+
<div className="space-y-8">
|
|
508
|
+
{/* Breadcrumb */}
|
|
509
|
+
<nav className="flex items-center gap-2 text-sm text-[var(--text-secondary)]">
|
|
510
|
+
<Link to="/docs">{t('breadcrumb.docs')}</Link>
|
|
511
|
+
<span>/</span>
|
|
512
|
+
<span>{t('apps.{app}.name')}</span>
|
|
513
|
+
</nav>
|
|
514
|
+
|
|
515
|
+
{/* Header */}
|
|
516
|
+
<header>
|
|
517
|
+
<h1 className="text-3xl font-bold mb-4 flex items-center gap-3">
|
|
518
|
+
<Folder className="w-8 h-8 text-[var(--color-primary-600)]" />
|
|
519
|
+
{t('apps.{app}.name')}
|
|
520
|
+
</h1>
|
|
521
|
+
<p className="text-lg text-[var(--text-secondary)]">
|
|
522
|
+
{t('apps.{app}.description')}
|
|
523
|
+
</p>
|
|
524
|
+
</header>
|
|
525
|
+
|
|
526
|
+
{/* Modules list */}
|
|
527
|
+
<section>
|
|
528
|
+
<h2 className="text-xl font-semibold mb-4">{t('common.modules')}</h2>
|
|
529
|
+
<div className="grid gap-4">
|
|
530
|
+
{modules.map((module) => (
|
|
531
|
+
<Link
|
|
532
|
+
key={module.id}
|
|
533
|
+
to={module.path}
|
|
534
|
+
className="card p-4 hover:border-[var(--color-primary-600)] transition-colors group"
|
|
535
|
+
>
|
|
536
|
+
<div className="flex items-center justify-between">
|
|
537
|
+
<div className="flex items-center gap-3">
|
|
538
|
+
<FileText className="w-6 h-6 text-[var(--color-primary-600)]" />
|
|
539
|
+
<div>
|
|
540
|
+
<h3 className="font-semibold group-hover:text-[var(--color-primary-600)]">
|
|
541
|
+
{module.name}
|
|
542
|
+
</h3>
|
|
543
|
+
<p className="text-sm text-[var(--text-secondary)]">
|
|
544
|
+
{module.description}
|
|
545
|
+
</p>
|
|
546
|
+
</div>
|
|
547
|
+
</div>
|
|
548
|
+
<div className="flex items-center gap-4">
|
|
549
|
+
<span className="text-sm text-[var(--text-secondary)]">
|
|
550
|
+
{module.features} features
|
|
551
|
+
</span>
|
|
552
|
+
<ChevronRight className="w-5 h-5 text-[var(--text-tertiary)] group-hover:text-[var(--color-primary-600)]" />
|
|
553
|
+
</div>
|
|
554
|
+
</div>
|
|
555
|
+
</Link>
|
|
556
|
+
))}
|
|
557
|
+
</div>
|
|
558
|
+
</section>
|
|
559
|
+
</div>
|
|
560
|
+
);
|
|
561
|
+
}
|
|
562
|
+
```
|
|
563
|
+
|
|
564
|
+
---
|
|
565
|
+
|
|
566
|
+
## Generation Checklist
|
|
567
|
+
|
|
568
|
+
When generating documentation:
|
|
569
|
+
|
|
570
|
+
- [ ] Use Context7 for current React patterns
|
|
571
|
+
- [ ] Generate `DocPage.tsx` with module documentation data
|
|
572
|
+
- [ ] Create/update `docs-business.json` (4 languages)
|
|
573
|
+
- [ ] Add route in `App.tsx`
|
|
574
|
+
- [ ] Update parent index if new module
|