From 707260955c481ce515e6572f85b8fd9c10997d63 Mon Sep 17 00:00:00 2001 From: ritikarawlani <38657562+ritikarawlani@users.noreply.github.com> Date: Fri, 12 Dec 2025 16:50:35 +0530 Subject: [PATCH 1/2] consolidate docs --- INDEX.md | 328 +++++++++++++ README.md | 217 ++++----- docs/01-getting-started/README.md | 91 ++++ .../01-getting-started/troubleshooting.md | 0 docs/02-user-guides/README.md | 163 +++++++ .../02-user-guides/build-logging-reference.md | 0 .../02-user-guides/build-logging.md | 0 .../02-user-guides/dak-usage-guide.md | 0 .../02-user-guides/image-optimization.md | 0 .../02-user-guides/saml-workflow.md | 0 .../02-user-guides/workflow-automation.md | 0 .../02-user-guides/workflow-interaction.md | 0 docs/03-architecture/README.md | 276 +++++++++++ .../dak-publication-architecture.md} | 0 .../mcp-services/faq-documentation.md} | 0 .../mcp-services/faq-service.md} | 0 .../03-architecture/page-framework.md | 0 docs/04-development/README.md | 375 ++++++++++++++ .../accessibility.md} | 0 .../compliance-framework.md} | 0 .../framework-hooks.md} | 0 .../04-development/typescript-migration.md | 0 docs/05-deployment/README.md | 381 +++++++++++++++ .../github-pages.md} | 0 .../05-deployment/overview.md | 0 .../workflows-analysis.md} | 0 docs/06-security/README.md | 336 +++++++++++++ .../additional-tools.md} | 0 .../codeql-analysis.md} | 0 .../framework-overlap-analysis.md} | 0 .../security-check-examples.md | 0 .../security-check-implementation.md} | 0 .../security-check-next-steps.md | 0 docs/{ => 06-security}/security-checks.md | 0 docs/07-features/README.md | 461 ++++++++++++++++++ .../future-enhancements.md} | 0 .../persona-viewer-enhancements.md} | 0 docs/08-development-history/README.md | 333 +++++++++++++ .../comment-simplification.md | 0 .../deployment-optimization.md | 0 .../pr-workflow-failure-notifier.md | 0 .../proposed-workflow-changes.md | 0 .../css-phases/css-review-workplan.md | 0 .../css-phases/phase2-completion.md | 0 .../css-phases/phase3-continuation.md | 0 .../css-phases/phase3-final.md | 0 .../css-phases/phase3-progress.md | 0 .../build-logging-implementation.md | 0 .../compliance-implementation.md | 0 .../dak-implementation-status.md | 0 .../pr-1092-implementation.md | 0 .../remember-me-implementation.md | 0 .../routing-implementation-status.md | 0 .../service-table-implementation.md} | 0 .../tinymce-migration-implementation.md | 0 .../tinymce-migration-plan.md | 0 .../wysiwyg-editor-comparison.md | 0 .../wysiwyg-implementation-guide.md | 0 .../mcp-improvements-summary.md} | 0 .../mcp-migration-implementation.md | 0 .../mcp-upstream-improvements.md} | 0 .../service-refactoring-analysis-revised.md | 0 .../service-refactoring-analysis.md | 0 .../service-refactoring-status.md | 0 .../sushi-refactor-summary.md} | 0 .../dak-typescript-refactoring.md} | 0 .../faq-typescript-integration.md} | 0 .../phase-6-editor-integration.md | 0 .../phase-7-migration-status.md | 0 .../miscellaneous/approval-summary.md | 0 .../miscellaneous/build-logging-section.md | 0 .../miscellaneous/copilot-instructions.md} | 0 .../miscellaneous/dak-migration-examples.md} | 0 .../miscellaneous/final-checklist.md | 0 .../image-asset-validity-report.md | 0 .../implementation-complete-summary.md | 0 .../miscellaneous/implementation-complete.md | 0 .../miscellaneous/implementation-status.md | 0 .../integration-complete-summary.md | 0 .../less-sensitive-fingerprint-options.md | 0 .../pr-1060-requirements-checklist.md | 0 .../miscellaneous/service-table.md} | 0 .../lazy-routing-analysis.md | 0 .../compliance-analysis.md | 0 .../compliance-checker-design.md | 0 .../heuristics-analysis-report.md | 0 .../dak-logical-model-update-plan.md | 0 .../other-analysis/geolocation-analysis.md | 0 .../other-analysis/merge-conflict-analysis.md | 0 .../merge-conflict-resolution-proposal.md | 0 .../typescript-migration-plan.md | 0 .../routing-analysis}/route-configuration.md | 0 .../routing-analysis/routing-analysis.md | 0 .../routing-consolidation-proposal.md | 0 .../routing-documentation-audit.md | 0 .../routing-implementation-guide.md} | 0 .../routing-logic-workflow-diagram.md} | 0 .../routing-migration-plan.md} | 0 .../routing-plan-finalized.md | 0 .../routing-solution-proposal.md} | 0 .../routing-solution-summary.md} | 0 .../localstorage-security-analysis.md | 0 .../sessionstorage-cross-tab-solution.md | 0 .../test-documentation/debug-faq-test.md | 0 .../test-documentation/phase-7-testing.md | 0 .../test-improved-pr-feedback.md | 0 .../pr-feedback-tests/test-pr-feedback.md | 0 .../test-session-feedback.md | 0 .../test-simplified-pr-comments.md | 0 .../test-failure-notification-example.md | 0 .../404-routing}/404-implementation.md | 0 .../always-build-pages-fix-883.md | 0 .../404-routing/badge-icon-path-fix.md | 0 .../404-routing/url-routing-fix.md} | 0 .../authentication/page-reload-token-loss.md | 0 .../authentication/pat-token-debugging.md | 0 .../authentication/pat-token-flow-analysis.md | 0 .../authentication/pat-token-investigation.md | 0 .../pat-token-loss-investigation.md | 0 .../deployment/branch-deployment-fix.md | 0 .../deployment/deploy-branch-eslint-fix.md | 0 .../deployment/deploy-branch-fix.md | 0 .../deployment}/deployment-fix-625.md | 0 .../deployment}/deployment-fix-691.md | 0 .../deployment/preview-builds-fix.md | 0 .../other-fixes/eslint-fix-summary.md | 0 .../other-fixes/routing-fix-plan.md | 0 .../other-fixes/who-repo-scanning-fix.md | 0 .../ticket-fixes/ui-fixes/bpmn-display-fix.md | 0 .../ui-fixes/dark-mode-image-audit.md | 0 .../pr-title-preservation-fix.md | 0 .../workflow-fixes}/workflow-comment-fix.md | 0 .../workflow-comment-marker-fix.md | 0 .../workflow-concurrency-fix-841.md | 0 test-pr-feedback-improvements.md | 74 --- 135 files changed, 2840 insertions(+), 195 deletions(-) create mode 100644 INDEX.md create mode 100644 docs/01-getting-started/README.md rename TROUBLESHOOTING.md => docs/01-getting-started/troubleshooting.md (100%) create mode 100644 docs/02-user-guides/README.md rename BUILD_LOGGING_QUICK_REFERENCE.md => docs/02-user-guides/build-logging-reference.md (100%) rename BUILD_LOGGING_USAGE_GUIDE.md => docs/02-user-guides/build-logging.md (100%) rename DAK_USAGE_GUIDE.md => docs/02-user-guides/dak-usage-guide.md (100%) rename IMAGE_OPTIMIZATION_GUIDE.md => docs/02-user-guides/image-optimization.md (100%) rename SAML_WORKFLOW.md => docs/02-user-guides/saml-workflow.md (100%) rename WORKFLOW_AUTOMATION_ENHANCEMENT.md => docs/02-user-guides/workflow-automation.md (100%) rename WORKFLOW_INTERACTION.md => docs/02-user-guides/workflow-interaction.md (100%) create mode 100644 docs/03-architecture/README.md rename docs/{dak-publication-software-architecture.md => 03-architecture/dak-publication-architecture.md} (100%) rename docs/{README-dak-faq-documentation.md => 03-architecture/mcp-services/faq-documentation.md} (100%) rename docs/{dak-faq-system.md => 03-architecture/mcp-services/faq-service.md} (100%) rename PAGE_FRAMEWORK_ANALYSIS.md => docs/03-architecture/page-framework.md (100%) create mode 100644 docs/04-development/README.md rename docs/{accessibility-linting.md => 04-development/accessibility.md} (100%) rename docs/{COMPLIANCE_FRAMEWORK_GUIDE.md => 04-development/compliance-framework.md} (100%) rename docs/{FRAMEWORK_HOOKS_USAGE_GUIDE.md => 04-development/framework-hooks.md} (100%) rename TYPESCRIPT_MIGRATION.md => docs/04-development/typescript-migration.md (100%) create mode 100644 docs/05-deployment/README.md rename docs/{DEPLOYMENT.md => 05-deployment/github-pages.md} (100%) rename DEPLOYMENT.md => docs/05-deployment/overview.md (100%) rename docs/{DEPLOYMENT_WORKFLOWS_ANALYSIS.md => 05-deployment/workflows-analysis.md} (100%) create mode 100644 docs/06-security/README.md rename docs/{additional-security-tools.md => 06-security/additional-tools.md} (100%) rename docs/{codeql-detailed-explanation.md => 06-security/codeql-analysis.md} (100%) rename docs/{security-framework-overlap-analysis.md => 06-security/framework-overlap-analysis.md} (100%) rename docs/{ => 06-security}/security-check-examples.md (100%) rename docs/{SECURITY_CHECK_IMPLEMENTATION.md => 06-security/security-check-implementation.md} (100%) rename docs/{ => 06-security}/security-check-next-steps.md (100%) rename docs/{ => 06-security}/security-checks.md (100%) create mode 100644 docs/07-features/README.md rename docs/{FUTURE_ENHANCEMENTS.md => 07-features/future-enhancements.md} (100%) rename docs/{PERSONA_VIEWER_ENHANCEMENTS.md => 07-features/persona-viewer-enhancements.md} (100%) create mode 100644 docs/08-development-history/README.md rename DEPLOYMENT_COMMENT_SIMPLIFICATION.md => docs/08-development-history/deployment-optimization/comment-simplification.md (100%) rename DEPLOYMENT_OPTIMIZATION.md => docs/08-development-history/deployment-optimization/deployment-optimization.md (100%) rename PR_WORKFLOW_FAILURE_NOTIFIER.md => docs/08-development-history/deployment-optimization/pr-workflow-failure-notifier.md (100%) rename PROPOSED_WORKFLOW_CHANGES.md => docs/08-development-history/deployment-optimization/proposed-workflow-changes.md (100%) rename CSS_REVIEW_WORKPLAN.md => docs/08-development-history/implementation-summaries/css-phases/css-review-workplan.md (100%) rename CSS_PHASE2_COMPLETION_SUMMARY.md => docs/08-development-history/implementation-summaries/css-phases/phase2-completion.md (100%) rename CSS_PHASE3_CONTINUATION_SUMMARY.md => docs/08-development-history/implementation-summaries/css-phases/phase3-continuation.md (100%) rename CSS_PHASE3_FINAL_SUMMARY.md => docs/08-development-history/implementation-summaries/css-phases/phase3-final.md (100%) rename CSS_PHASE3_PROGRESS_REPORT.md => docs/08-development-history/implementation-summaries/css-phases/phase3-progress.md (100%) rename BUILD_LOGGING_IMPLEMENTATION_PLAN.md => docs/08-development-history/implementation-summaries/feature-implementations/build-logging-implementation.md (100%) rename COMPLIANCE_IMPLEMENTATION_SUMMARY.md => docs/08-development-history/implementation-summaries/feature-implementations/compliance-implementation.md (100%) rename DAK_IMPLEMENTATION_STATUS.md => docs/08-development-history/implementation-summaries/feature-implementations/dak-implementation-status.md (100%) rename PR_1092_IMPLEMENTATION_SUMMARY.md => docs/08-development-history/implementation-summaries/feature-implementations/pr-1092-implementation.md (100%) rename REMEMBER_ME_IMPLEMENTATION_GUIDE.md => docs/08-development-history/implementation-summaries/feature-implementations/remember-me-implementation.md (100%) rename ROUTING_IMPLEMENTATION_STATUS.md => docs/08-development-history/implementation-summaries/feature-implementations/routing-implementation-status.md (100%) rename docs/{SERVICE_TABLE_IMPLEMENTATION.md => 08-development-history/implementation-summaries/feature-implementations/service-table-implementation.md} (100%) rename docs/{ => 08-development-history/implementation-summaries/migration-summaries/editor-migration}/tinymce-migration-implementation.md (100%) rename docs/{ => 08-development-history/implementation-summaries/migration-summaries/editor-migration}/tinymce-migration-plan.md (100%) rename docs/{ => 08-development-history/implementation-summaries/migration-summaries/editor-migration}/wysiwyg-editor-comparison.md (100%) rename docs/{ => 08-development-history/implementation-summaries/migration-summaries/editor-migration}/wysiwyg-implementation-guide.md (100%) rename docs/{mcp-improvements-implementation-summary.md => 08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-improvements-summary.md} (100%) rename docs/{ => 08-development-history/implementation-summaries/migration-summaries/mcp-migration}/mcp-migration-implementation.md (100%) rename docs/{mcp-upstream-improvements-analysis.md => 08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-upstream-improvements.md} (100%) rename SERVICE_REFACTORING_ANALYSIS_REVISED.md => docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis-revised.md (100%) rename SERVICE_REFACTORING_ANALYSIS.md => docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis.md (100%) rename SERVICE_REFACTORING_STATUS.md => docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-status.md (100%) rename docs/{SUSHI_REFACTOR_SUMMARY.md => 08-development-history/implementation-summaries/migration-summaries/service-refactoring/sushi-refactor-summary.md} (100%) rename docs/{DAK_TYPESCRIPT_REFACTORING.md => 08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/dak-typescript-refactoring.md} (100%) rename docs/{faq-typescript-integration-analysis.md => 08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/faq-typescript-integration.md} (100%) rename PHASE_6_EDITOR_INTEGRATION.md => docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-6-editor-integration.md (100%) rename PHASE_7_MIGRATION_STATUS.md => docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-7-migration-status.md (100%) rename APPROVAL_SUMMARY.md => docs/08-development-history/miscellaneous/approval-summary.md (100%) rename README_BUILD_LOGGING_SECTION.md => docs/08-development-history/miscellaneous/build-logging-section.md (100%) rename docs/{COPILOT_INSTRUCTIONS.md => 08-development-history/miscellaneous/copilot-instructions.md} (100%) rename docs/{DAK_MIGRATION_EXAMPLES.md => 08-development-history/miscellaneous/dak-migration-examples.md} (100%) rename FINAL_CHECKLIST.md => docs/08-development-history/miscellaneous/final-checklist.md (100%) rename IMAGE_ASSET_VALIDITY_REPORT.md => docs/08-development-history/miscellaneous/image-asset-validity-report.md (100%) rename IMPLEMENTATION_COMPLETE_SUMMARY.md => docs/08-development-history/miscellaneous/implementation-complete-summary.md (100%) rename IMPLEMENTATION_COMPLETE.md => docs/08-development-history/miscellaneous/implementation-complete.md (100%) rename IMPLEMENTATION_STATUS.md => docs/08-development-history/miscellaneous/implementation-status.md (100%) rename INTEGRATION_COMPLETE_SUMMARY.md => docs/08-development-history/miscellaneous/integration-complete-summary.md (100%) rename LESS_SENSITIVE_FINGERPRINT_OPTIONS.md => docs/08-development-history/miscellaneous/less-sensitive-fingerprint-options.md (100%) rename docs/{ => 08-development-history/miscellaneous}/pr-1060-requirements-checklist.md (100%) rename docs/{SERVICE_TABLE.md => 08-development-history/miscellaneous/service-table.md} (100%) rename LAZY_ROUTING_ANALYSIS.md => docs/08-development-history/technical-analysis/architecture-analysis/lazy-routing-analysis.md (100%) rename COMPLIANCE_ANALYSIS.md => docs/08-development-history/technical-analysis/compliance-analysis/compliance-analysis.md (100%) rename COMPLIANCE_CHECKER_DESIGN.md => docs/08-development-history/technical-analysis/compliance-analysis/compliance-checker-design.md (100%) rename HEURISTICS_ANALYSIS_REPORT.md => docs/08-development-history/technical-analysis/compliance-analysis/heuristics-analysis-report.md (100%) rename DAK_LOGICAL_MODEL_UPDATE_PLAN.md => docs/08-development-history/technical-analysis/other-analysis/dak-logical-model-update-plan.md (100%) rename GEOLOCATION_ANALYSIS.md => docs/08-development-history/technical-analysis/other-analysis/geolocation-analysis.md (100%) rename MERGE_CONFLICT_ANALYSIS.md => docs/08-development-history/technical-analysis/other-analysis/merge-conflict-analysis.md (100%) rename MERGE_CONFLICT_RESOLUTION_PROPOSAL.md => docs/08-development-history/technical-analysis/other-analysis/merge-conflict-resolution-proposal.md (100%) rename TYPESCRIPT_MIGRATION_PLAN.md => docs/08-development-history/technical-analysis/other-analysis/typescript-migration-plan.md (100%) rename docs/{ => 08-development-history/technical-analysis/routing-analysis}/route-configuration.md (100%) rename ROUTING_ANALYSIS.md => docs/08-development-history/technical-analysis/routing-analysis/routing-analysis.md (100%) rename ROUTING_CONSOLIDATION_PROPOSAL.md => docs/08-development-history/technical-analysis/routing-analysis/routing-consolidation-proposal.md (100%) rename ROUTING_DOCUMENTATION_AUDIT.md => docs/08-development-history/technical-analysis/routing-analysis/routing-documentation-audit.md (100%) rename docs/{ROUTING_IMPLEMENTATION_GUIDE.md => 08-development-history/technical-analysis/routing-analysis/routing-implementation-guide.md} (100%) rename docs/{ROUTING_LOGIC_WORKFLOW_DIAGRAM.md => 08-development-history/technical-analysis/routing-analysis/routing-logic-workflow-diagram.md} (100%) rename docs/{ROUTING_MIGRATION_PLAN.md => 08-development-history/technical-analysis/routing-analysis/routing-migration-plan.md} (100%) rename ROUTING_PLAN_FINALIZED.md => docs/08-development-history/technical-analysis/routing-analysis/routing-plan-finalized.md (100%) rename docs/{ROUTING_SOLUTION_PROPOSAL.md => 08-development-history/technical-analysis/routing-analysis/routing-solution-proposal.md} (100%) rename docs/{ROUTING_SOLUTION_SUMMARY.md => 08-development-history/technical-analysis/routing-analysis/routing-solution-summary.md} (100%) rename LOCALSTORAGE_SECURITY_ANALYSIS.md => docs/08-development-history/technical-analysis/security-analysis/localstorage-security-analysis.md (100%) rename SESSIONSTORAGE_CROSS_TAB_SOLUTION.md => docs/08-development-history/technical-analysis/security-analysis/sessionstorage-cross-tab-solution.md (100%) rename debug-faq-test.md => docs/08-development-history/test-documentation/debug-faq-test.md (100%) rename PHASE_7_TESTING_DOCUMENTATION.md => docs/08-development-history/test-documentation/phase-7-testing.md (100%) rename test-improved-pr-feedback.md => docs/08-development-history/test-documentation/pr-feedback-tests/test-improved-pr-feedback.md (100%) rename test-pr-feedback.md => docs/08-development-history/test-documentation/pr-feedback-tests/test-pr-feedback.md (100%) rename test-session-feedback.md => docs/08-development-history/test-documentation/pr-feedback-tests/test-session-feedback.md (100%) rename test-simplified-pr-comments.md => docs/08-development-history/test-documentation/pr-feedback-tests/test-simplified-pr-comments.md (100%) rename TEST_FAILURE_NOTIFICATION_EXAMPLE.md => docs/08-development-history/test-documentation/test-failure-notification-example.md (100%) rename docs/{ => 08-development-history/ticket-fixes/404-routing}/404-implementation.md (100%) rename docs/{ => 08-development-history/ticket-fixes/404-routing}/always-build-pages-fix-883.md (100%) rename BADGE_ICON_PATH_FIX.md => docs/08-development-history/ticket-fixes/404-routing/badge-icon-path-fix.md (100%) rename docs/{URL_ROUTING_FIX.md => 08-development-history/ticket-fixes/404-routing/url-routing-fix.md} (100%) rename PAGE_RELOAD_TOKEN_LOSS_ANALYSIS.md => docs/08-development-history/ticket-fixes/authentication/page-reload-token-loss.md (100%) rename PAT_TOKEN_DEBUGGING_GUIDE.md => docs/08-development-history/ticket-fixes/authentication/pat-token-debugging.md (100%) rename PAT_TOKEN_FLOW_ANALYSIS.md => docs/08-development-history/ticket-fixes/authentication/pat-token-flow-analysis.md (100%) rename PAT_TOKEN_INVESTIGATION_README.md => docs/08-development-history/ticket-fixes/authentication/pat-token-investigation.md (100%) rename PAT_TOKEN_LOSS_INVESTIGATION.md => docs/08-development-history/ticket-fixes/authentication/pat-token-loss-investigation.md (100%) rename BRANCH_DEPLOYMENT_FIX.md => docs/08-development-history/ticket-fixes/deployment/branch-deployment-fix.md (100%) rename DEPLOY_BRANCH_ESLINT_FIX.md => docs/08-development-history/ticket-fixes/deployment/deploy-branch-eslint-fix.md (100%) rename DEPLOY_BRANCH_FIX.md => docs/08-development-history/ticket-fixes/deployment/deploy-branch-fix.md (100%) rename docs/{ => 08-development-history/ticket-fixes/deployment}/deployment-fix-625.md (100%) rename docs/{ => 08-development-history/ticket-fixes/deployment}/deployment-fix-691.md (100%) rename PREVIEW_BUILDS_FIX.md => docs/08-development-history/ticket-fixes/deployment/preview-builds-fix.md (100%) rename ESLINT_FIX_SUMMARY.md => docs/08-development-history/ticket-fixes/other-fixes/eslint-fix-summary.md (100%) rename ROUTING_FIX_PLAN.md => docs/08-development-history/ticket-fixes/other-fixes/routing-fix-plan.md (100%) rename WHO_REPO_SCANNING_FIX_SUMMARY.md => docs/08-development-history/ticket-fixes/other-fixes/who-repo-scanning-fix.md (100%) rename BPMN_DISPLAY_FIX.md => docs/08-development-history/ticket-fixes/ui-fixes/bpmn-display-fix.md (100%) rename DARK_MODE_IMAGE_AUDIT.md => docs/08-development-history/ticket-fixes/ui-fixes/dark-mode-image-audit.md (100%) rename PR_TITLE_PRESERVATION_FIX.md => docs/08-development-history/ticket-fixes/workflow-fixes/pr-title-preservation-fix.md (100%) rename docs/{ => 08-development-history/ticket-fixes/workflow-fixes}/workflow-comment-fix.md (100%) rename WORKFLOW_COMMENT_MARKER_FIX_SUMMARY.md => docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-marker-fix.md (100%) rename docs/{ => 08-development-history/ticket-fixes/workflow-fixes}/workflow-concurrency-fix-841.md (100%) delete mode 100644 test-pr-feedback-improvements.md diff --git a/INDEX.md b/INDEX.md new file mode 100644 index 0000000000..4380942376 --- /dev/null +++ b/INDEX.md @@ -0,0 +1,328 @@ +# SGEX Workbench - Documentation Index + +**Last Updated**: December 12, 2024 +**Total Documents**: 125+ +**Organization**: 8 Main Categories + +--- + +## 🚀 Quick Start + +**New to SGEX?** Start here: +- [Getting Started](01-getting-started/README.md) - Installation, setup, and first steps +- [User Guides](02-user-guides/README.md) - How-to guides for using SGEX features +- [Troubleshooting](01-getting-started/troubleshooting.md) - Common issues and solutions + +**For Developers:** +- [Development Setup](04-development/README.md) - Development environment and standards +- [Architecture Overview](03-architecture/README.md) - System design and components +- [Deployment Guide](05-deployment/README.md) - Deployment procedures and CI/CD + +--- + +## 📚 Documentation Structure + +### 👤 **User Documentation** + +#### [01-getting-started/](01-getting-started/) +First-stop documentation for new users +- Installation and setup +- Authentication configuration +- Quick start guide +- Troubleshooting basics + +#### [02-user-guides/](02-user-guides/) +Comprehensive guides for using SGEX features +- **[DAK Usage Guide](02-user-guides/dak-usage-guide.md)** - Working with Digital Adaptation Kits +- **[Build Logging](02-user-guides/build-logging.md)** - Understanding build logs +- **[Image Optimization](02-user-guides/image-optimization.md)** - Optimizing images +- **[SAML Workflow](02-user-guides/saml-workflow.md)** - SAML authentication +- **[Workflow Automation](02-user-guides/workflow-automation.md)** - Automating workflows + +--- + +### 🏗️ **System Documentation** + +#### [03-architecture/](03-architecture/) +System design and architecture documentation +- **System Overview** - High-level architecture +- **[Page Framework](03-architecture/page-framework.md)** - Page framework design +- **[DAK Publication Architecture](03-architecture/dak-publication-architecture.md)** - Publication system +- **MCP Services** - Model Context Protocol services + - [FAQ Service](03-architecture/mcp-services/faq-service.md) + - [FAQ Documentation](03-architecture/mcp-services/faq-documentation.md) + +#### [04-development/](04-development/) +Developer guides and coding standards +- **[TypeScript Migration](04-development/typescript-migration.md)** - TypeScript adoption guide +- **[Compliance Framework](04-development/compliance-framework.md)** - Compliance checking +- **[Framework Hooks](04-development/framework-hooks.md)** - Using framework hooks +- **[Accessibility](04-development/accessibility.md)** - Accessibility standards + +#### [05-deployment/](05-deployment/) +Deployment procedures and CI/CD +- **[Overview](05-deployment/overview.md)** - Deployment strategy +- **[GitHub Pages](05-deployment/github-pages.md)** - GitHub Pages deployment +- **[Workflows Analysis](05-deployment/workflows-analysis.md)** - CI/CD workflows + +#### [06-security/](06-security/) +Security practices and implementation +- **[Security Checks](06-security/security-checks.md)** - Automated security scanning +- **[CodeQL Analysis](06-security/codeql-analysis.md)** - Static analysis +- **[Security Examples](06-security/security-check-examples.md)** - Security examples +- **[Security Implementation](06-security/security-check-implementation.md)** - Implementation guide + +#### [07-features/](07-features/) +Feature-specific technical documentation +- **[Future Enhancements](07-features/future-enhancements.md)** - Planned features +- **[Persona Viewer](07-features/persona-viewer-enhancements.md)** - Persona viewer features + +--- + +### 📜 **Development History** + +#### [08-development-history/](08-development-history/) +Historical record of development decisions and implementations + +##### **Ticket Fixes** (20+ fixes) +- [404 Routing Fixes](08-development-history/ticket-fixes/404-routing/) (4 fixes) +- [Authentication Fixes](08-development-history/ticket-fixes/authentication/) (5 fixes) +- [Deployment Fixes](08-development-history/ticket-fixes/deployment/) (6 fixes) +- [UI Fixes](08-development-history/ticket-fixes/ui-fixes/) (2 fixes) +- [Workflow Fixes](08-development-history/ticket-fixes/workflow-fixes/) (4 fixes) +- [Other Fixes](08-development-history/ticket-fixes/other-fixes/) (3 fixes) + +##### **Implementation Summaries** (30+ docs) +- [Feature Implementations](08-development-history/implementation-summaries/feature-implementations/) (7 docs) +- [TypeScript Refactoring](08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/) (4 docs) +- [MCP Migration](08-development-history/implementation-summaries/migration-summaries/mcp-migration/) (3 docs) +- [Editor Migration](08-development-history/implementation-summaries/migration-summaries/editor-migration/) (4 docs) +- [Service Refactoring](08-development-history/implementation-summaries/migration-summaries/service-refactoring/) (4 docs) +- [CSS Phases](08-development-history/implementation-summaries/css-phases/) (5 docs) + +##### **Technical Analysis** (19 docs) +- [Architecture Analysis](08-development-history/technical-analysis/architecture-analysis/) (1 doc) +- [Routing Analysis](08-development-history/technical-analysis/routing-analysis/) (10 docs) +- [Security Analysis](08-development-history/technical-analysis/security-analysis/) (2 docs) +- [Compliance Analysis](08-development-history/technical-analysis/compliance-analysis/) (3 docs) +- [Other Analysis](08-development-history/technical-analysis/other-analysis/) (5 docs) + +##### **Test Documentation** (8 docs) +- [Test Documentation](08-development-history/test-documentation/) (3 docs) +- [PR Feedback Tests](08-development-history/test-documentation/pr-feedback-tests/) (5 docs) + +##### **Other History** +- [Deployment Optimization](08-development-history/deployment-optimization/) (4 docs) +- [Miscellaneous](08-development-history/miscellaneous/) (13 docs) + +--- + +## 🔍 Documentation by Topic + +### Authentication +- **User Guide**: [Getting Started - Authentication](01-getting-started/authentication.md) +- **Security**: [Token Storage](06-security/token-storage.md) +- **History**: [Authentication Fixes](08-development-history/ticket-fixes/authentication/) + - PAT Token Debugging + - PAT Token Investigation + - Token Loss Analysis + - Token Flow Analysis + +### Deployment +- **System Docs**: [Deployment Guide](05-deployment/README.md) + - [GitHub Pages Deployment](05-deployment/github-pages.md) + - [Workflows Analysis](05-deployment/workflows-analysis.md) +- **History**: [Deployment Fixes](08-development-history/ticket-fixes/deployment/) + - Branch Deployment Fix + - Deploy Branch Fix + - Preview Builds Fix + - Deployment Fix 625 + - Deployment Fix 691 + +### Routing +- **Architecture**: [Routing Architecture](03-architecture/routing-architecture.md) +- **History**: [Routing Analysis](08-development-history/technical-analysis/routing-analysis/) + - Routing Analysis + - Routing Consolidation Proposal + - Routing Documentation Audit + - Routing Plan Finalized + - Routing Solution Proposal + - Routing Implementation Guide + +### TypeScript Migration +- **Development**: [TypeScript Migration Guide](04-development/typescript-migration.md) +- **History**: [TypeScript Refactoring](08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/) + - Phase 6: Editor Integration + - Phase 7: Migration Status + - DAK TypeScript Refactoring + - FAQ TypeScript Integration + +### Security +- **System Docs**: [Security](06-security/) + - Security Checks + - CodeQL Analysis + - Security Examples + - Security Implementation +- **History**: [Security Analysis](08-development-history/technical-analysis/security-analysis/) + - LocalStorage Security Analysis + - SessionStorage Cross-Tab Solution + +### MCP Services +- **Architecture**: [MCP Services](03-architecture/mcp-services/) + - FAQ Service + - FAQ Documentation +- **History**: [MCP Migration](08-development-history/implementation-summaries/migration-summaries/mcp-migration/) + - MCP Migration Implementation + - MCP Improvements Summary + - MCP Upstream Improvements + +### WYSIWYG Editor +- **History**: [Editor Migration](08-development-history/implementation-summaries/migration-summaries/editor-migration/) + - TinyMCE Migration Plan + - TinyMCE Migration Implementation + - WYSIWYG Editor Comparison + - WYSIWYG Implementation Guide + +### UI & Design +- **User Guide**: [Image Optimization](02-user-guides/image-optimization.md) +- **History**: [UI Fixes](08-development-history/ticket-fixes/ui-fixes/) + - BPMN Display Fix + - Dark Mode Image Audit + +### Workflows & CI/CD +- **User Guide**: [Workflow Automation](02-user-guides/workflow-automation.md) +- **Deployment**: [Workflows Analysis](05-deployment/workflows-analysis.md) +- **History**: [Workflow Fixes](08-development-history/ticket-fixes/workflow-fixes/) + - PR Title Preservation Fix + - Workflow Comment Marker Fix + - Workflow Comment Fix + - Workflow Concurrency Fix + +### DAK (Digital Adaptation Kits) +- **User Guide**: [DAK Usage Guide](02-user-guides/dak-usage-guide.md) +- **Architecture**: [DAK Publication Architecture](03-architecture/dak-publication-architecture.md) +- **History**: [DAK Implementation Status](08-development-history/implementation-summaries/feature-implementations/dak-implementation-status.md) + +### Compliance & Quality +- **Development**: [Compliance Framework](04-development/compliance-framework.md) +- **History**: [Compliance Analysis](08-development-history/technical-analysis/compliance-analysis/) + - Compliance Analysis + - Compliance Checker Design + - Heuristics Analysis Report + +### Testing +- **History**: [Test Documentation](08-development-history/test-documentation/) + - Phase 7 Testing + - Test Failure Notification Example + - Debug FAQ Test + - PR Feedback Tests (5 docs) + +--- + +## 📊 Documentation Statistics + +### By Category +- **User Documentation**: 15 documents + - Getting Started: 4 docs + - User Guides: 11 docs +- **System Documentation**: 42 documents + - Architecture: 6 docs + - Development: 4 docs + - Deployment: 3 docs + - Security: 7 docs + - Features: 2 docs +- **Development History**: 68 documents + - Ticket Fixes: 24 docs + - Implementation Summaries: 27 docs + - Technical Analysis: 21 docs + - Test Documentation: 8 docs + - Deployment Optimization: 4 docs + - Miscellaneous: 13 docs + +### By Type +- **Guides**: 15 documents +- **Architecture**: 6 documents +- **Bug Fixes**: 24 documents +- **Implementation**: 27 documents +- **Analysis**: 21 documents +- **Security**: 7 documents +- **Testing**: 8 documents +- **Miscellaneous**: 17 documents + +--- + +## 🔗 External Documentation + +### Public Facing +- **[public/docs/](../public/docs/)** - User-facing documentation + - Project Plan + - Requirements + - Solution Architecture + - DAK Components Guide + +### Package Documentation +- **[packages/dak-core/](../packages/dak-core/)** - DAK Core package +- **[packages/storage-services/](../packages/storage-services/)** - Storage services +- **[packages/vcs-services/](../packages/vcs-services/)** - VCS services +- **[packages/utils/](../packages/utils/)** - Utility packages + +### Service Documentation +- **[services/dak-faq-mcp/](../services/dak-faq-mcp/)** - DAK FAQ MCP service +- **[services/dak-publication-api/](../services/dak-publication-api/)** - Publication API + +--- + +## 📝 Documentation Standards + +### File Naming +- Use lowercase with hyphens: `feature-name.md` +- Be descriptive: `routing-consolidation-proposal.md` not `routing.md` +- Include context: `pat-token-debugging.md` not `debugging.md` + +### Structure +- Start with purpose/overview +- Include table of contents for long docs +- Use clear headings and sections +- Include examples and code snippets +- End with next steps or references + +### Categories +- **User Documentation**: How-to guides for end users +- **System Documentation**: Technical architecture and design +- **Development History**: Historical context and decisions + +--- + +## 🆘 Need Help? + +### Finding Documentation +1. **Search by topic** using the topic index above +2. **Browse by category** using the structure section +3. **Check development history** for context on specific features + +### Contributing +See [CONTRIBUTING.md](../CONTRIBUTING.md) for guidelines on: +- Adding new documentation +- Updating existing documentation +- Documentation review process +- Style guide and standards + +### Questions +- **Issues**: [GitHub Issues](https://github.com/litlfred/sgex/issues) +- **Discussions**: [GitHub Discussions](https://github.com/litlfred/sgex/discussions) + +--- + +## 📅 Maintenance + +### Review Schedule +- **Monthly**: Review and update getting started guides +- **Quarterly**: Review architecture and system documentation +- **As Needed**: Update development history when completing features + +### Ownership +- **User Documentation**: Product team +- **System Documentation**: Engineering team +- **Development History**: Automated (via development process) + +--- diff --git a/README.md b/README.md index 5111605e6d..d3bd228077 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ Browse and select from available DAK repositories with enhanced scanning display ![Repository Selection](https://github.com/user-attachments/assets/1c606285-519f-4985-91a1-52739069ae39) ### DAK Component Management -Access and edit the 8 core DAK components organized according to the WHO SMART Guidelines framework, including Health Interventions, Generic Personas, User Scenarios, Business Processes, Core Data Elements, Decision-Support Logic, Program Indicators, and Requirements. +Access and edit the 9 core DAK components organized according to the WHO SMART Guidelines framework, including Health Interventions, Generic Personas, User Scenarios, Business Processes, Core Data Elements, Decision-Support Logic, Program Indicators, Requirements, and Test Scenarios. ![DAK Components](https://github.com/user-attachments/assets/2b3c8e7d-cdd2-4a61-a482-a2c1bc6cb0cb) @@ -50,12 +50,42 @@ The SGEX Workbench is a browser-based, static web application for collaborative - All UI schemas are rendered using [JSON Forms](https://jsonforms.io/) for standards compliance and accessibility. - All schemas and documentation follow the terminology and branding of [WHO SMART Guidelines](https://www.who.int/teams/digital-health-and-innovation/smart-guidelines). +## 📚 Documentation + +All project documentation is now organized in the `docs/` directory with clear categories: + +### 👤 User Documentation +- **[📖 Documentation Index](docs/INDEX.md)** - Comprehensive documentation catalog +- **[🚀 Getting Started](docs/01-getting-started/)** - Installation, authentication, and first steps +- **[📘 User Guides](docs/02-user-guides/)** - How-to guides for using SGEX features + +### 🏗️ System Documentation +- **[🏛️ Architecture](docs/03-architecture/)** - System design and architecture +- **[💻 Development Guide](docs/04-development/)** - Development standards and practices +- **[🚀 Deployment Guide](docs/05-deployment/)** - Deployment procedures and CI/CD +- **[🔐 Security](docs/06-security/)** - Security practices and compliance +- **[✨ Features](docs/07-features/)** - Feature-specific documentation + +### 📜 Development History +- **[📜 Development History](docs/08-development-history/)** - Historical context, bug fixes, and implementation details + - 24 ticket fixes organized by category + - 27 implementation summaries + - 21 technical analysis documents + - Complete audit trail of development decisions + +### 📄 Public Documentation +For public-facing documentation, see [public/docs/](public/docs/) including: +- Project Plan +- Requirements +- Solution Architecture +- DAK Components Guide + ## Development Setup ### Prerequisites -- **Node.js**: Version 16.x or higher (tested with Node.js 18.x and 20.x) -- **npm**: Version 8.x or higher (comes with Node.js) +- **Node.js**: Version 20.x or higher +- **npm**: Version 10.x or higher ### Installation @@ -120,7 +150,7 @@ npm run build:verify # Build and verify in one command npm run verify-404 # Verify existing build ``` -For detailed implementation information, see [docs/404-implementation.md](docs/404-implementation.md). +For detailed deployment information, see [docs/05-deployment/](docs/05-deployment/). ## MCP Services @@ -149,10 +179,12 @@ npm start - **Fly.io Production**: Public HTTPS deployment with GitHub OAuth authentication #### Documentation -Complete MCP documentation: [`public/docs/mcp/`](public/docs/mcp/) -Deployment guide: [`services/dak-faq-mcp/DEPLOYMENT.md`](services/dak-faq-mcp/DEPLOYMENT.md) +- Complete MCP documentation: [`public/docs/mcp/`](public/docs/mcp/) +- Deployment guide: [`services/dak-faq-mcp/DEPLOYMENT.md`](services/dak-faq-mcp/DEPLOYMENT.md) +- Architecture: [`docs/03-architecture/mcp-services/`](docs/03-architecture/mcp-services/) **Security**: Local development bypasses authentication. Production deployment requires GitHub OAuth and collaborator access to `litlfred/sgex`. + ### Docker 1. **Build the docker image** @@ -187,34 +219,63 @@ For **classic tokens**: This authentication method is fully compatible with static deployments and requires no backend server. -### Project Structure +## Project Structure ``` sgex/ -├── public/ # Static assets -├── src/ # Source code -│ ├── components/ # React components -│ ├── App.js # Main application component -│ └── index.js # Application entry point -├── public/docs/ # Project documentation -├── package.json # Dependencies and scripts -└── README.md # This file +├── docs/ # 📚 All documentation (organized by category) +│ ├── INDEX.md # Master documentation index +│ ├── 01-getting-started/ +│ ├── 02-user-guides/ +│ ├── 03-architecture/ +│ ├── 04-development/ +│ ├── 05-deployment/ +│ ├── 06-security/ +│ ├── 07-features/ +│ └── 08-development-history/ +├── packages/ # Monorepo packages +│ ├── dak-core/ # Core DAK business logic +│ ├── storage-services/ # Caching and persistence +│ ├── vcs-services/ # GitHub integration +│ └── utils/ # Shared utilities +├── services/ # MCP services +│ ├── dak-faq-mcp/ # FAQ service +│ └── dak-publication-api/ # Publication API +├── src/ # Main application source +│ ├── components/ # React components +│ ├── services/ # Application services +│ ├── hooks/ # Custom React hooks +│ └── styles/ # Global styles +├── public/ # Static assets +│ └── docs/ # Public-facing documentation +└── scripts/ # Build and utility scripts ``` -### Available Scripts +## Available Scripts +### Core Development - `npm start` - Runs the app in development mode - `npm test` - Launches the test runner in interactive watch mode - `npm run build` - Builds the app for production (includes TypeScript type checking and schema generation) -- `npm run type-check` - Runs TypeScript type checking without compilation -- `npm run type-check:watch` - Runs TypeScript type checking in watch mode -- `npm run generate-schemas` - Generates JSON schemas from TypeScript types + +### Code Quality - `npm run lint` - Runs ESLint on all source files (supports JavaScript and TypeScript) - `npm run lint:a11y` - Shows only accessibility (jsx-a11y) warnings - `npm run lint:fix` - Automatically fixes linting issues where possible -- `npm run eject` - **Note: This is a one-way operation. Don't do this unless you're sure!** +- `npm run type-check` - Runs TypeScript type checking without compilation +- `npm run type-check:watch` - Runs TypeScript type checking in watch mode + +### Advanced +- `npm run generate-schemas` - Generates JSON schemas from TypeScript types +- `npm run check-framework-compliance` - Check framework compliance +- `npm run generate-service-table` - Generate service documentation table + +### Testing +- `npm run compliance:profile` - Test profile creation compliance +- `npm run compliance:all` - Run all compliance tests +- `npm run test:compliance` - Run compliance test suite -### TypeScript Migration +## TypeScript Migration SGEX Workbench is currently undergoing a phased migration to TypeScript for improved type safety, better IDE support, and enhanced developer experience. The migration includes: @@ -223,16 +284,16 @@ SGEX Workbench is currently undergoing a phased migration to TypeScript for impr - **Type Safety**: Gradual adoption of TypeScript across the codebase - **Documentation**: Generated type documentation and schemas -For detailed information about the TypeScript migration, see [TYPESCRIPT_MIGRATION.md](TYPESCRIPT_MIGRATION.md). +For detailed information about the TypeScript migration, see [docs/04-development/typescript-migration.md](docs/04-development/typescript-migration.md). -#### Current TypeScript Features +### Current TypeScript Features - **Core Types**: Comprehensive type definitions for GitHub API, DAK structures, and application state - **Runtime Validation**: Type-safe JSON validation using generated schemas - **Schema Publishing**: Automated schema generation and publishing to `public/docs/schemas/` - **Development Tools**: TypeScript-aware linting, type checking, and IDE support -#### Using TypeScript Features +### Using TypeScript Features ```typescript // Import types for better development experience @@ -243,9 +304,11 @@ import { validateAndCast } from './services/runtimeValidationService'; const user = validateAndCast('GitHubUser', userData); ``` +## Accessibility & Security + ### Accessibility Linting -The project uses `eslint-plugin-jsx-a11y` to enforce accessibility best practices. See [docs/accessibility-linting.md](docs/accessibility-linting.md) for detailed information about accessibility rules and how to fix common issues. +The project uses `eslint-plugin-jsx-a11y` to enforce accessibility best practices. See [docs/04-development/accessibility.md](docs/04-development/accessibility.md) for detailed information about accessibility rules and how to fix common issues. ### Security Checks @@ -259,20 +322,20 @@ The project includes comprehensive automated security checks that run on every P - **Secret Scanning** - Detects hardcoded secrets - **Framework Compliance** - Ensures security best practices -See [docs/security-checks.md](docs/security-checks.md) for detailed information about security checks and how to interpret results. +See [docs/06-security/](docs/06-security/) for comprehensive security documentation. -### Troubleshooting +## Troubleshooting If you encounter build or installation issues: -- **eslint-scope module not found**: See [TROUBLESHOOTING.md](TROUBLESHOOTING.md) for detailed solutions +- **eslint-scope module not found**: See [docs/01-getting-started/troubleshooting.md](docs/01-getting-started/troubleshooting.md) for detailed solutions - **Port 3000 already in use**: The development server will automatically try to use an alternative port (3001, 3002, etc.) - **Build issues**: Try deleting `node_modules/` and `package-lock.json`, then run `npm install` again - **Memory issues**: If you encounter JavaScript heap out of memory errors, try setting `NODE_OPTIONS=--max-old-space-size=4096` before running build commands -For more detailed troubleshooting guidance, see [TROUBLESHOOTING.md](TROUBLESHOOTING.md). +For more detailed troubleshooting guidance, see [docs/01-getting-started/troubleshooting.md](docs/01-getting-started/troubleshooting.md). -For more information about contributing, see [CONTRIBUTING.md](CONTRIBUTING.md). +For information about contributing, see [CONTRIBUTING.md](CONTRIBUTING.md). ## WHO SMART Guidelines DAK Components @@ -292,7 +355,7 @@ The SGEX Workbench supports editing of the **9 core Digital Adaptation Kit (DAK) ### Additional Components The SGEX Workbench also supports additional structured knowledge representations including Terminology, FHIR Profiles, FHIR Extensions, FHIR Questionnaires, and Test Data & Examples. -For detailed information about each component, see the [DAK Components Documentation](public/docs/dak-components.md). +For detailed information about each component, see the [public/docs/dak-components.md](public/docs/dak-components.md). *Note: Scheduling tables are considered a special case of decision tables and are included within the Decision Support Logic component.* @@ -315,36 +378,6 @@ This separation ensures: - Manual control over landing page updates - Independent operation of each deployment type -### Deploy Feature Branch - -**Workflow**: `Deploy Feature Branch` (`.github/workflows/branch-deployment.yml`) - -**Automatic Triggers**: -- Push to any branch (except `gh-pages`) -- Pull request events -- Excludes documentation-only changes - -**Process**: -1. **Builds** branch-specific React app with correct base path -2. **Deploys** to branch subdirectory (e.g., `/main/`, `/feature-branch/`) -3. **Posts** deployment URLs to associated pull request comments -4. **Preserves** existing branch directories and landing page - -### Landing Page Deployment - -**Workflow**: `Deploy Landing Page` (`.github/workflows/landing-page-deploy.yml`) - -**Manual Triggers**: -- GitHub Actions manual trigger (`workflow_dispatch`) -- Can be triggered from any branch -- Uses build scripts from the triggering branch - -**Process**: -1. **Builds** self-contained landing page with branch/PR selectors -2. **Preserves** all existing branch deployments -3. **Deploys** landing page to root of GitHub Pages -4. **Maintains** independent assets (CSS, JS, images) - ### URL Structure and Access #### Main Application @@ -364,65 +397,7 @@ This separation ensures: - **Features**: Branch selector, pull request previews, contribution portal - **Deployment**: Manual via landing page deployment workflow -### Branch Preview Workflow Details - -**Triggered by**: Push to any branch, pull request events - -1. **Build** → Installs dependencies, builds branch-specific React app -2. **Deploy** → Updates branch subdirectory on GitHub Pages -3. **Notify** → Posts deployment URLs to associated pull request comments -4. **Complete** → Branch preview available within 2-3 minutes - -### Landing Page Update Process - -**Triggered by**: Manual workflow dispatch in GitHub Actions - -1. **Build** → Creates self-contained landing page with updated branch listings -2. **Preserve** → Maintains all existing branch directories -3. **Deploy** → Updates root landing page with independent assets -4. **Complete** → Updated landing page available within 2-3 minutes - -#### How to Update the Landing Page - -To manually update the landing page: - -1. **Navigate to GitHub Actions** in the repository -2. **Select "Deploy Landing Page"** workflow -3. **Click "Run workflow"** -4. **Choose source branch** (optional - defaults to current branch) -5. **Run** the workflow - -The landing page will be updated with latest branch listings, pull request previews, and self-contained assets. - -### Workflow Independence Benefits - -The compartmentalized approach provides several advantages: - -- **Isolated Updates**: Branch deployments don't trigger landing page rebuilds -- **Selective Control**: Landing page can be updated independently when needed -- **Asset Isolation**: Landing page has its own CSS, JS, and image assets -- **Build Optimization**: Landing page build is ~83% smaller (only includes BranchListing component) -- **Deployment Flexibility**: Landing page can use build scripts from any branch -- **Reduced Complexity**: Each workflow has a single, clear responsibility - -### Pull Request Integration - -When you push to a branch with an associated pull request: - -- **Auto-detects** PR by branch name or commit SHA -- **Posts comment** with deployment URLs in PR conversation -- **Updates existing** comments instead of creating duplicates -- **Includes** branch preview URL and deployment metadata -- **Provides** direct access for reviewers to test changes - -## Documentation - -All project documentation is located in the `public/docs/` directory: - -- [Project Plan](public/docs/project-plan.md) - Overall project planning and milestones -- [Requirements](public/docs/requirements.md) - Detailed functional and non-functional requirements -- [Solution Architecture](public/docs/solution-architecture.md) - Technical architecture and design decisions -- [DAK Components](public/docs/dak-components.md) - Comprehensive guide to the 8 WHO SMART Guidelines DAK components +For detailed deployment documentation, see [docs/05-deployment/](docs/05-deployment/). ## License @@ -435,4 +410,4 @@ This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENS - [bpmn-js](https://github.com/bpmn-io/bpmn-js) - [dmn-js](https://github.com/bpmn-io/dmn-js) - [Octokit](https://github.com/octokit/rest.js) -- [GitHub REST API](https://docs.github.com/en/rest) +- [GitHub REST API](https://docs.github.com/en/rest) \ No newline at end of file diff --git a/docs/01-getting-started/README.md b/docs/01-getting-started/README.md new file mode 100644 index 0000000000..d72ef9c839 --- /dev/null +++ b/docs/01-getting-started/README.md @@ -0,0 +1,91 @@ +# Getting Started with SGEX Workbench + +Welcome to SGEX Workbench! This section contains everything you need to get started with editing WHO SMART Guidelines Digital Adaptation Kits (DAKs). + +## 📚 Contents + +- **[Troubleshooting](troubleshooting.md)** - Common issues and solutions +- **Authentication** *(Coming Soon)* - Setting up GitHub authentication +- **Installation** *(Coming Soon)* - Installation and setup guide +- **Quick Start** *(Coming Soon)* - Your first DAK edit + +## 🚀 Quick Start Overview + +SGEX Workbench is a browser-based collaborative editor that works directly with GitHub repositories. Here's what you need to know: + +### Prerequisites +- Modern web browser (Chrome, Firefox, Edge, Safari) +- GitHub account +- GitHub Personal Access Token (PAT) + +### Authentication +SGEX uses GitHub Personal Access Tokens for secure authentication. When you first access the workbench, you'll be guided through creating a PAT with the correct permissions. + +### First Steps +1. **Sign In** - Click "Sign in with Personal Access Token" +2. **Create PAT** - Follow the step-by-step instructions to create your token +3. **Select Organization** - Choose your WHO organization +4. **Select Repository** - Pick the DAK repository you want to work with +5. **Select DAK** - Choose which DAK to edit +6. **Start Editing** - Access the 9 core DAK components + +## 🆘 Need Help? + +### Common Issues +Check the [Troubleshooting Guide](troubleshooting.md) for solutions to common problems including: +- Authentication issues +- Repository access problems +- Build errors +- Browser compatibility + +### Additional Resources +- **[User Guides](../02-user-guides/)** - Detailed how-to guides +- **[Main README](../../README.md)** - Project overview +- **[Documentation Index](../INDEX.md)** - Complete documentation catalog + +### Support +- **Issues**: [GitHub Issues](https://github.com/litlfred/sgex/issues) +- **Discussions**: [GitHub Discussions](https://github.com/litlfred/sgex/discussions) + +## 🎯 What You Can Do with SGEX + +### Edit DAK Components +- Health Interventions & Recommendations +- Generic Personas +- User Scenarios +- Business Processes & Workflows (BPMN) +- Core Data Elements +- Decision Support Logic (DMN) +- Program Indicators +- Requirements +- Test Scenarios + +### Collaborate +- Work with team members on the same repository +- Create pull requests for review +- Track changes with Git version control +- Preview changes before publishing + +### Validate +- Real-time validation against WHO standards +- Schema compliance checking +- FHIR profile validation + +## 📖 Learning Path + +1. **Start Here**: Read this overview +2. **Install & Setup**: Follow the installation guide *(coming soon)* +3. **Authenticate**: Set up your GitHub token *(coming soon)* +4. **First Edit**: Complete the quick start tutorial *(coming soon)* +5. **Go Deeper**: Explore the [User Guides](../02-user-guides/) + +## 🔗 Quick Links + +- [Back to Documentation Index](../INDEX.md) +- [User Guides](../02-user-guides/) +- [Architecture](../03-architecture/) +- [Development Guide](../04-development/) + +--- + +**Note**: SGEX Workbench is under active development. Documentation is continuously updated. Last updated: December 2024 \ No newline at end of file diff --git a/TROUBLESHOOTING.md b/docs/01-getting-started/troubleshooting.md similarity index 100% rename from TROUBLESHOOTING.md rename to docs/01-getting-started/troubleshooting.md diff --git a/docs/02-user-guides/README.md b/docs/02-user-guides/README.md new file mode 100644 index 0000000000..b6f8890464 --- /dev/null +++ b/docs/02-user-guides/README.md @@ -0,0 +1,163 @@ +# SGEX Workbench - User Guides + +Comprehensive how-to guides for using SGEX Workbench features effectively. + +## 📚 Available Guides + +### Core Workflows +- **[DAK Usage Guide](dak-usage-guide.md)** *(Coming Soon)* - Complete guide to working with Digital Adaptation Kits +- **[Workflow Automation](workflow-automation.md)** *(Coming Soon)* - Automating common workflows +- **[Workflow Interaction](workflow-interaction.md)** *(Coming Soon)* - Understanding workflow interactions + +### Build & Deployment +- **[Build Logging](build-logging.md)** *(Coming Soon)* - Understanding build logs and output +- **[Build Logging Reference](build-logging-reference.md)** *(Coming Soon)* - Quick reference for build log messages + +### Asset Management +- **[Image Optimization](image-optimization.md)** *(Coming Soon)* - Optimizing images for performance and accessibility + +### Authentication +- **[SAML Workflow](saml-workflow.md)** *(Coming Soon)* - SAML authentication workflow + +## 🎯 How to Use These Guides + +Each guide is structured to help you accomplish specific tasks: + +1. **Purpose** - What the guide covers +2. **Prerequisites** - What you need before starting +3. **Step-by-Step Instructions** - Detailed procedures +4. **Examples** - Real-world usage examples +5. **Troubleshooting** - Common issues and solutions +6. **Next Steps** - Where to go from here + +## 📖 Guide Categories + +### For New Users +Start with these guides if you're new to SGEX: +- DAK Usage Guide +- Build Logging + +### For Content Editors +Focus on these if you're editing DAK content: +- DAK Usage Guide +- Image Optimization +- Workflow Automation + +### For Administrators +Essential for those managing SGEX deployments: +- SAML Workflow +- Build Logging Reference + +## 🚀 Common Tasks + +### Editing DAK Components +1. Sign in with your GitHub token +2. Select your repository +3. Choose the DAK component to edit +4. Make your changes +5. Save and commit + +**Guide**: [DAK Usage Guide](dak-usage-guide.md) + +### Working with BPMN Workflows +1. Navigate to Business Processes +2. Select a workflow file +3. Use the visual BPMN editor +4. Validate your changes +5. Save and commit + +**Guide**: [DAK Usage Guide](dak-usage-guide.md) - Business Processes section + +### Optimizing Images +1. Upload your image +2. Run the optimization tool +3. Review size reduction +4. Apply optimizations +5. Commit changes + +**Guide**: [Image Optimization](image-optimization.md) + +### Understanding Build Output +1. Trigger a build +2. Monitor build progress +3. Review build logs +4. Identify errors or warnings +5. Fix issues and rebuild + +**Guide**: [Build Logging](build-logging.md) + +## 💡 Tips & Best Practices + +### General Tips +- **Save Frequently** - Commit your changes regularly +- **Use Descriptive Commit Messages** - Help others understand your changes +- **Preview Before Committing** - Review your changes in preview mode +- **Follow WHO Standards** - Ensure compliance with WHO SMART Guidelines + +### Workflow Tips +- **Work on Feature Branches** - Create branches for major changes +- **Test Thoroughly** - Validate before merging +- **Collaborate** - Use pull requests for team review +- **Document Changes** - Include rationale in commit messages + +### Performance Tips +- **Optimize Images** - Use the image optimization guide +- **Minimize File Sizes** - Keep DAK files manageable +- **Use Caching** - Leverage browser caching for faster loads + +## 🆘 Getting Help + +### Can't Find What You Need? +- Check the [Documentation Index](../INDEX.md) for all available docs +- Search [GitHub Issues](https://github.com/litlfred/sgex/issues) +- Ask in [GitHub Discussions](https://github.com/litlfred/sgex/discussions) + +### Found an Error? +- Report issues via the help button in the application +- Create a bug report on GitHub +- Suggest documentation improvements + +## 🔗 Related Documentation + +### Essential Reading +- [Getting Started](../01-getting-started/) - Initial setup and configuration +- [Architecture](../03-architecture/) - Understanding SGEX architecture +- [Troubleshooting](../01-getting-started/troubleshooting.md) - Common issues + +### Advanced Topics +- [Development Guide](../04-development/) - For developers contributing to SGEX +- [Deployment Guide](../05-deployment/) - Deployment procedures +- [Security](../06-security/) - Security best practices + +## 📅 Documentation Status + +| Guide | Status | Last Updated | +|-------|--------|--------------| +| DAK Usage Guide | Coming Soon | - | +| Build Logging | Coming Soon | - | +| Build Logging Reference | Coming Soon | - | +| Image Optimization | Coming Soon | - | +| SAML Workflow | Coming Soon | - | +| Workflow Automation | Coming Soon | - | +| Workflow Interaction | Coming Soon | - | + +## 🤝 Contributing to Documentation + +Help improve these guides: +1. Identify gaps or errors +2. Suggest improvements +3. Contribute examples +4. Share best practices + +See [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines. + +## 🔗 Quick Links + +- [Back to Documentation Index](../INDEX.md) +- [Getting Started](../01-getting-started/) +- [Main README](../../README.md) + +--- + +**Last Updated**: December 2024 +**Maintained By**: SGEX Workbench Team \ No newline at end of file diff --git a/BUILD_LOGGING_QUICK_REFERENCE.md b/docs/02-user-guides/build-logging-reference.md similarity index 100% rename from BUILD_LOGGING_QUICK_REFERENCE.md rename to docs/02-user-guides/build-logging-reference.md diff --git a/BUILD_LOGGING_USAGE_GUIDE.md b/docs/02-user-guides/build-logging.md similarity index 100% rename from BUILD_LOGGING_USAGE_GUIDE.md rename to docs/02-user-guides/build-logging.md diff --git a/DAK_USAGE_GUIDE.md b/docs/02-user-guides/dak-usage-guide.md similarity index 100% rename from DAK_USAGE_GUIDE.md rename to docs/02-user-guides/dak-usage-guide.md diff --git a/IMAGE_OPTIMIZATION_GUIDE.md b/docs/02-user-guides/image-optimization.md similarity index 100% rename from IMAGE_OPTIMIZATION_GUIDE.md rename to docs/02-user-guides/image-optimization.md diff --git a/SAML_WORKFLOW.md b/docs/02-user-guides/saml-workflow.md similarity index 100% rename from SAML_WORKFLOW.md rename to docs/02-user-guides/saml-workflow.md diff --git a/WORKFLOW_AUTOMATION_ENHANCEMENT.md b/docs/02-user-guides/workflow-automation.md similarity index 100% rename from WORKFLOW_AUTOMATION_ENHANCEMENT.md rename to docs/02-user-guides/workflow-automation.md diff --git a/WORKFLOW_INTERACTION.md b/docs/02-user-guides/workflow-interaction.md similarity index 100% rename from WORKFLOW_INTERACTION.md rename to docs/02-user-guides/workflow-interaction.md diff --git a/docs/03-architecture/README.md b/docs/03-architecture/README.md new file mode 100644 index 0000000000..fdc3542575 --- /dev/null +++ b/docs/03-architecture/README.md @@ -0,0 +1,276 @@ +# System Architecture + +Technical documentation about SGEX Workbench architecture, design patterns, and system components. + +## 📐 Architecture Overview + +SGEX Workbench is a browser-based, static web application built on modern web technologies with a focus on standards compliance, performance, and maintainability. + +### Core Principles +- **Static-First**: No backend required - fully client-side +- **Standards-Based**: Follows WHO SMART Guidelines specifications +- **Modular**: Organized as a monorepo with independent packages +- **GitHub-Native**: Deep integration with GitHub APIs +- **Type-Safe**: Migrating to TypeScript for improved reliability + +## 📚 Documentation Contents + +### System Design +- **[Page Framework](page-framework.md)** - Page framework architecture and design patterns +- **[DAK Publication Architecture](dak-publication-architecture.md)** - Publication system design +- **System Overview** *(Coming Soon)* - High-level architecture and component relationships +- **Component Architecture** *(Coming Soon)* - Component design patterns + +### Services +- **[MCP Services](mcp-services/)** - Model Context Protocol services + - [FAQ Service](mcp-services/faq-service.md) + - [FAQ Documentation](mcp-services/faq-documentation.md) + +### Packages +- **DAK Core Package** *(See [packages/dak-core/](../../packages/dak-core/))* - Core business logic +- **Storage Services** *(See [packages/storage-services/](../../packages/storage-services/))* - Caching and persistence +- **VCS Services** *(See [packages/vcs-services/](../../packages/vcs-services/))* - GitHub integration +- **Utilities** *(See [packages/utils/](../../packages/utils/))* - Shared utilities + +## 🏗️ System Architecture + +``` +┌─────────────────────────────────────────────────────────────┐ +│ SGEX Workbench UI │ +│ (React Application) │ +└─────────────────────────────────────────────────────────────┘ + │ + ┌───────────────────┼───────────────────┐ + │ │ │ +┌───────▼───────┐ ┌───────▼───────┐ ┌───────▼───────┐ +│ DAK Core │ │ Storage │ │ VCS Services │ +│ Package │ │ Services │ │ (GitHub) │ +└───────────────┘ └───────────────┘ └───────────────┘ + │ │ │ + └───────────────────┼───────────────────┘ + │ + ┌───────▼───────┐ + │ Utilities │ + │ Package │ + └───────────────┘ +``` + +### Layer Responsibilities + +#### Presentation Layer (React UI) +- User interface components +- State management +- Routing and navigation +- Form validation and rendering + +#### Business Logic Layer (DAK Core) +- WHO SMART Guidelines compliance +- DAK validation and processing +- Component discovery and management +- Schema validation + +#### Storage Layer +- Browser localStorage management +- Caching strategies +- Repository caching +- Bookmark management + +#### Integration Layer (VCS Services) +- GitHub API integration +- Authentication management +- Repository operations +- Pull request management + +## 🎯 Key Design Decisions + +### 1. Monorepo Architecture +**Decision**: Use a monorepo with independent packages +**Rationale**: +- Code reusability across services +- Consistent versioning +- Easier dependency management +- Simplified development workflow + +### 2. Static Deployment +**Decision**: No backend server required +**Rationale**: +- Simplified deployment +- Lower operational costs +- Better scalability +- GitHub Pages compatible + +### 3. GitHub-Native Approach +**Decision**: Direct GitHub API integration +**Rationale**: +- Native version control +- Collaboration features built-in +- No additional infrastructure +- Familiar workflow for developers + +### 4. React + TypeScript +**Decision**: Modern React with TypeScript migration +**Rationale**: +- Type safety and better IDE support +- Improved maintainability +- Better error detection +- Industry standard tooling + +### 5. JSON Forms for UI +**Decision**: Use JSON Forms for rendering schemas +**Rationale**: +- Standards-compliant form generation +- Accessibility built-in +- Consistent UI patterns +- Schema-driven development + +## 📦 Package Organization + +### Dependency Hierarchy +``` +@sgex/dak-core (pure business logic, no dependencies) +├── @sgex/utils (lazy loading, factories) +├── @sgex/storage-services (caching, bookmarks) +├── @sgex/vcs-services (GitHub operations) +└── @sgex/web-services (React UI components) +``` + +### Package Roles + +**@sgex/dak-core** +- Core DAK business logic +- WHO SMART Guidelines integration +- Validation services +- Component discovery + +**@sgex/storage-services** +- Browser localStorage abstraction +- Caching mechanisms +- Repository caching +- Bookmark management + +**@sgex/vcs-services** +- Git/GitHub operations +- Authentication handling +- Repository management +- Pull request operations + +**@sgex/utils** +- Lazy loading patterns +- Factory patterns +- Performance optimization +- Shared utilities + +## 🔐 Security Architecture + +### Authentication +- GitHub Personal Access Token (PAT) based +- Secure token storage in browser +- No server-side authentication +- Token encryption at rest + +### Data Storage +- Browser localStorage for caching +- No sensitive data persistence +- Secure token handling +- CORS-compliant requests + +### Content Security +- Content Security Policy (CSP) headers +- XSS prevention +- Input sanitization +- Safe HTML rendering + +## 🚀 Performance Considerations + +### Optimization Strategies +- **Lazy Loading**: Components loaded on demand +- **Code Splitting**: Route-based code splitting +- **Caching**: Aggressive caching of repository data +- **Memoization**: React hooks for expensive computations + +### Build Optimization +- Tree shaking for smaller bundles +- Minification and compression +- Asset optimization +- Source map generation for debugging + +## 🔄 Data Flow + +### Read Operations +``` +User Action → React Component → Service Layer → GitHub API + ↓ + Cache Check + ↓ + Return Cached Data (if available) +``` + +### Write Operations +``` +User Action → Form Validation → DAK Core Validation + ↓ + GitHub API Call + ↓ + Update Cache + ↓ + Notify UI +``` + +## 📊 Component Interaction + +### Component Communication +- Props for parent-child communication +- Context API for cross-cutting concerns +- Custom hooks for shared logic +- Event emitters for loose coupling + +### State Management +- React Context for global state +- Local state for component-specific data +- Derived state through useMemo +- Side effects through useEffect + +## 🔍 Integration Points + +### External Systems +- **GitHub API**: Repository operations +- **WHO SMART Guidelines**: Schema validation +- **FHIR Specifications**: Resource validation +- **MCP Services**: FAQ and publication services + +### Browser APIs +- **localStorage**: Data persistence +- **fetch**: HTTP requests +- **History API**: Routing +- **Web Workers**: Background processing (future) + +## 📖 Further Reading + +### Architecture Documents +- [Page Framework](page-framework.md) - Detailed page framework design +- [DAK Publication Architecture](dak-publication-architecture.md) - Publication system +- [MCP Services](mcp-services/) - Service architecture + +### Related Documentation +- [Development Guide](../04-development/) - Development practices +- [Deployment Guide](../05-deployment/) - Deployment architecture +- [Security](../06-security/) - Security implementation + +### Package Documentation +- [DAK Core README](../../packages/dak-core/README.md) +- [Storage Services README](../../packages/storage-services/README.md) +- [VCS Services README](../../packages/vcs-services/README.md) +- [Utils README](../../packages/utils/README.md) + +## 🔗 Quick Links + +- [Back to Documentation Index](../INDEX.md) +- [Development Guide](../04-development/) +- [Deployment Guide](../05-deployment/) +- [Main README](../../README.md) + +--- + +**Last Updated**: December 2024 +**Architecture Version**: 2.0 +**Maintained By**: SGEX Workbench Engineering Team \ No newline at end of file diff --git a/docs/dak-publication-software-architecture.md b/docs/03-architecture/dak-publication-architecture.md similarity index 100% rename from docs/dak-publication-software-architecture.md rename to docs/03-architecture/dak-publication-architecture.md diff --git a/docs/README-dak-faq-documentation.md b/docs/03-architecture/mcp-services/faq-documentation.md similarity index 100% rename from docs/README-dak-faq-documentation.md rename to docs/03-architecture/mcp-services/faq-documentation.md diff --git a/docs/dak-faq-system.md b/docs/03-architecture/mcp-services/faq-service.md similarity index 100% rename from docs/dak-faq-system.md rename to docs/03-architecture/mcp-services/faq-service.md diff --git a/PAGE_FRAMEWORK_ANALYSIS.md b/docs/03-architecture/page-framework.md similarity index 100% rename from PAGE_FRAMEWORK_ANALYSIS.md rename to docs/03-architecture/page-framework.md diff --git a/docs/04-development/README.md b/docs/04-development/README.md new file mode 100644 index 0000000000..b42162739f --- /dev/null +++ b/docs/04-development/README.md @@ -0,0 +1,375 @@ +# Development Guide + +Developer documentation for contributing to SGEX Workbench, including setup, standards, and best practices. + +## 📚 Documentation Contents + +- **[TypeScript Migration](typescript-migration.md)** - TypeScript adoption guide and migration status +- **[Compliance Framework](compliance-framework.md)** - Compliance checking and validation +- **[Framework Hooks](framework-hooks.md)** - Using SGEX framework hooks +- **[Accessibility](accessibility.md)** - Accessibility standards and linting +- **Development Setup** *(Coming Soon)* - Setting up your development environment +- **Testing Guide** *(Coming Soon)* - Testing guidelines and practices +- **Code Standards** *(Coming Soon)* - Coding standards and conventions + +## 🚀 Getting Started + +### Prerequisites +- Node.js 20.x or higher +- npm 10.x or higher +- Git +- Modern code editor (VS Code recommended) + +### Initial Setup +```bash +# Clone the repository +git clone https://github.com/litlfred/sgex.git +cd sgex + +# Install dependencies +npm install + +# Start development server +npm start +``` + +The application will be available at `http://localhost:3000/sgex` + +## 🏗️ Project Structure + +``` +sgex/ +├── packages/ # Monorepo packages +│ ├── dak-core/ # Core business logic +│ ├── storage-services/ # Storage and caching +│ ├── vcs-services/ # GitHub integration +│ ├── utils/ # Shared utilities +│ └── web-services/ # Web-specific services +├── services/ # MCP services +│ ├── dak-faq-mcp/ # FAQ service +│ └── dak-publication-api/ # Publication API +├── src/ # Main application source +│ ├── components/ # React components +│ ├── services/ # Application services +│ ├── hooks/ # Custom React hooks +│ ├── contexts/ # React contexts +│ └── styles/ # Global styles +├── public/ # Static assets +└── docs/ # Documentation +``` + +## 💻 Development Workflow + +### 1. Create a Feature Branch +```bash +git checkout -b feature/your-feature-name +``` + +### 2. Make Changes +- Write code following our standards +- Add tests for new functionality +- Update documentation as needed + +### 3. Run Tests +```bash +npm test +``` + +### 4. Lint Your Code +```bash +npm run lint +npm run lint:fix # Auto-fix issues +``` + +### 5. Type Check (TypeScript) +```bash +npm run type-check +``` + +### 6. Commit Changes +```bash +git add . +git commit -m "feat: add new feature" +``` + +Follow [Conventional Commits](https://www.conventionalcommits.org/) format. + +### 7. Push and Create PR +```bash +git push origin feature/your-feature-name +``` + +Then create a pull request on GitHub. + +## 📜 Coding Standards + +### TypeScript +- Use TypeScript for all new files +- See [TypeScript Migration Guide](typescript-migration.md) +- Enable strict mode +- Avoid `any` types + +### React +- Use functional components with hooks +- Follow React best practices +- Use proper prop types +- Implement error boundaries + +### File Naming +- Components: `PascalCase.tsx` or `PascalCase.jsx` +- Services: `camelCase.ts` or `camelCase.js` +- Utilities: `camelCase.ts` or `camelCase.js` +- Tests: `*.test.ts` or `*.test.js` + +### Code Style +- Use ESLint configuration provided +- 2 spaces for indentation +- Single quotes for strings +- Trailing commas in objects/arrays +- Semicolons required + +## 🧪 Testing + +### Running Tests +```bash +# Run all tests +npm test + +# Run tests in watch mode +npm test -- --watch + +# Run specific test file +npm test -- ComponentName.test.js + +# Run with coverage +npm test -- --coverage +``` + +### Writing Tests +```javascript +import { render, screen } from '@testing-library/react'; +import { ComponentName } from './ComponentName'; + +describe('ComponentName', () => { + it('renders correctly', () => { + render(); + expect(screen.getByText('Expected Text')).toBeInTheDocument(); + }); +}); +``` + +### Test Organization +- Unit tests alongside source files +- Integration tests in `src/tests/` +- E2E tests in `e2e/` (coming soon) + +## ♿ Accessibility + +### Requirements +- WCAG 2.1 Level AA compliance +- Semantic HTML elements +- Proper ARIA labels +- Keyboard navigation support +- Screen reader compatibility + +### Linting +```bash +npm run lint:a11y # Check accessibility issues +``` + +See [Accessibility Guide](accessibility.md) for details. + +## 📦 Package Development + +### Working with Packages +```bash +# Navigate to package +cd packages/dak-core + +# Install dependencies +npm install + +# Run package tests +npm test + +# Build package +npm run build +``` + +### Creating New Packages +1. Create directory in `packages/` +2. Add `package.json` with proper metadata +3. Follow monorepo conventions +4. Add to root workspace configuration + +## 🔧 Available Scripts + +### Development +```bash +npm start # Start development server +npm run build # Production build +npm test # Run tests +npm run lint # Lint code +npm run lint:fix # Fix lint issues +npm run type-check # TypeScript type checking +``` + +### Advanced +```bash +npm run generate-schemas # Generate JSON schemas +npm run check-framework-compliance # Check compliance +npm run generate-service-table # Generate service table +``` + +## 🎯 Framework Features + +### Page Framework +Use the page framework for consistent page structure: +```javascript +import { PageLayout, PageHeader } from './components/framework'; + +function MyPage() { + return ( + + + {/* Page content */} + + ); +} +``` + +See [Framework Hooks Guide](framework-hooks.md) for details. + +### Compliance Framework +Integrate compliance checking: +```javascript +import { useCompliance } from './hooks/useCompliance'; + +function MyComponent() { + const { checkCompliance, errors } = useCompliance(); + + // Use compliance checking +} +``` + +See [Compliance Framework Guide](compliance-framework.md). + +## 🔍 Code Quality + +### ESLint Rules +- No unused variables +- Proper React hooks usage +- Accessibility rules enabled +- Security rules enabled +- TypeScript rules (when applicable) + +### Pre-commit Hooks +- Automatically run on commit +- Lint staged files +- Run type checking +- Verify tests pass + +## 📖 Documentation Standards + +### Code Comments +```javascript +/** + * Brief description of function + * + * @param {string} param1 - Description of param1 + * @param {number} param2 - Description of param2 + * @returns {boolean} Description of return value + */ +function myFunction(param1, param2) { + // Implementation +} +``` + +### Component Documentation +```javascript +/** + * ComponentName - Brief description + * + * @component + * @example + * + */ +``` + +### README Files +- Every package needs a README +- Include usage examples +- Document API if applicable +- Link to related documentation + +## 🐛 Debugging + +### Browser DevTools +- Use React Developer Tools +- Check console for errors +- Use Network tab for API calls +- Profile performance with Profiler + +### VS Code Debugging +```json +{ + "type": "chrome", + "request": "launch", + "name": "Debug SGEX", + "url": "http://localhost:3000/sgex", + "webRoot": "${workspaceFolder}/src" +} +``` + +## 🔄 TypeScript Migration + +The project is undergoing TypeScript migration. See [TypeScript Migration Guide](typescript-migration.md) for: +- Migration phases +- Best practices +- Type definitions +- Common patterns + +## 🤝 Contributing + +### Pull Request Process +1. Create feature branch +2. Make changes with tests +3. Update documentation +4. Pass all checks +5. Request review +6. Address feedback +7. Merge when approved + +### Code Review Guidelines +- Be constructive and respectful +- Focus on code quality +- Check for test coverage +- Verify documentation updates +- Test manually when needed + +See [CONTRIBUTING.md](../../CONTRIBUTING.md) for full guidelines. + +## 🔗 Related Documentation + +- [Architecture](../03-architecture/) - System architecture +- [Deployment](../05-deployment/) - Deployment procedures +- [Security](../06-security/) - Security practices +- [Features](../07-features/) - Feature documentation + +## 🔗 Quick Links + +- [Back to Documentation Index](../INDEX.md) +- [Getting Started](../01-getting-started/) +- [Architecture](../03-architecture/) +- [Main README](../../README.md) + +## 📞 Getting Help + +- **Issues**: [GitHub Issues](https://github.com/litlfred/sgex/issues) +- **Discussions**: [GitHub Discussions](https://github.com/litlfred/sgex/discussions) +- **Documentation**: [Full Documentation Index](../INDEX.md) + +--- + +**Last Updated**: December 2024 +**Maintained By**: SGEX Workbench Development Team \ No newline at end of file diff --git a/docs/accessibility-linting.md b/docs/04-development/accessibility.md similarity index 100% rename from docs/accessibility-linting.md rename to docs/04-development/accessibility.md diff --git a/docs/COMPLIANCE_FRAMEWORK_GUIDE.md b/docs/04-development/compliance-framework.md similarity index 100% rename from docs/COMPLIANCE_FRAMEWORK_GUIDE.md rename to docs/04-development/compliance-framework.md diff --git a/docs/FRAMEWORK_HOOKS_USAGE_GUIDE.md b/docs/04-development/framework-hooks.md similarity index 100% rename from docs/FRAMEWORK_HOOKS_USAGE_GUIDE.md rename to docs/04-development/framework-hooks.md diff --git a/TYPESCRIPT_MIGRATION.md b/docs/04-development/typescript-migration.md similarity index 100% rename from TYPESCRIPT_MIGRATION.md rename to docs/04-development/typescript-migration.md diff --git a/docs/05-deployment/README.md b/docs/05-deployment/README.md new file mode 100644 index 0000000000..c81ac119b7 --- /dev/null +++ b/docs/05-deployment/README.md @@ -0,0 +1,381 @@ +# Deployment Guide + +Documentation for deploying SGEX Workbench to various environments, including GitHub Pages, Docker, and custom hosting. + +## 📚 Documentation Contents + +- **[Overview](overview.md)** - Deployment strategy and architecture +- **[GitHub Pages](github-pages.md)** - GitHub Pages deployment (primary) +- **[Workflows Analysis](workflows-analysis.md)** - CI/CD workflows detailed analysis +- **Docker Deployment** *(Coming Soon)* - Docker containerization +- **Custom Hosting** *(Coming Soon)* - Self-hosted deployment + +## 🚀 Deployment Overview + +SGEX Workbench uses a **multi-branch deployment strategy** with GitHub Pages as the primary deployment target. Each branch gets its own preview URL, enabling parallel development and testing. + +### Deployment Architecture + +``` +Production: https://litlfred.github.io/sgex/main/ +Feature Branches: https://litlfred.github.io/sgex/{branch-name}/ +Landing Page: https://litlfred.github.io/sgex/ +``` + +### Key Features +- ✅ Automatic deployment on push +- ✅ Branch-specific preview URLs +- ✅ Pull request integration +- ✅ Independent landing page +- ✅ Zero-downtime deployments + +## 📦 Deployment Options + +### 1. GitHub Pages (Recommended) +**Best For**: Public projects, collaboration, preview deployments + +**Pros**: +- Free hosting +- Automatic HTTPS +- CDN distribution +- GitHub integration +- Multi-branch support + +**Cons**: +- Public repositories only (for free) +- Static sites only +- Limited to 1GB size + +**Setup**: See [GitHub Pages Guide](github-pages.md) + +### 2. Docker Container +**Best For**: Self-hosted environments, custom infrastructure + +**Pros**: +- Consistent environment +- Easy scaling +- Version control +- Works anywhere + +**Cons**: +- Requires infrastructure +- More complex setup +- Manual updates + +**Quick Start**: +```bash +# Build image +docker build -t sgex . + +# Run container +docker run -p 3000:3000 sgex +``` + +### 3. Custom Hosting +**Best For**: Enterprise environments, air-gapped networks + +**Pros**: +- Full control +- Custom domains +- Private networks +- Security compliance + +**Cons**: +- Manual setup +- Ongoing maintenance +- Infrastructure costs + +## 🔄 CI/CD Workflows + +### Automated Workflows + +#### 1. Branch Deployment +**Trigger**: Push to any branch +**Action**: Builds and deploys to `/{branch-name}/` +**Output**: Preview URL in PR comment + +**Workflow**: `.github/workflows/branch-deployment.yml` + +```yaml +name: Deploy Feature Branch +on: + push: + branches-ignore: + - gh-pages +``` + +#### 2. Landing Page Deployment +**Trigger**: Manual workflow dispatch +**Action**: Updates landing page with branch selector +**Output**: Updated root page + +**Workflow**: `.github/workflows/landing-page-deployment.yml` + +```yaml +name: Deploy Landing Page +on: + workflow_dispatch: +``` + +#### 3. Code Quality +**Trigger**: Pull request +**Action**: Linting, tests, type checking +**Output**: Status checks on PR + +**Workflow**: `.github/workflows/code-quality.yml` + +#### 4. Security Checks +**Trigger**: Pull request +**Action**: Security scanning, dependency audit +**Output**: Security report + +**Workflow**: `.github/workflows/pr-security-check.yml` + +## 🛠️ Manual Deployment + +### Build for Production +```bash +# Install dependencies +npm install + +# Build production bundle +npm run build + +# Output in build/ directory +``` + +### Deploy to GitHub Pages +```bash +# Using gh-pages package +npm install -g gh-pages + +# Deploy build directory +gh-pages -d build -b gh-pages +``` + +### Deploy with GitHub Actions +Push to main branch - automatic deployment triggered. + +## 🔐 Environment Configuration + +### Environment Variables +Create `.env` file (not committed): +```bash +REACT_APP_GITHUB_API_URL=https://api.github.com +REACT_APP_ENVIRONMENT=production +``` + +### Build Configuration +`package.json`: +```json +{ + "homepage": "/sgex/" +} +``` + +### GitHub Pages Configuration +Repository Settings → Pages: +- Source: Deploy from branch +- Branch: `gh-pages` +- Folder: `/ (root)` + +## 📊 Deployment Workflow + +### Standard Deployment +``` +1. Developer pushes to branch + ↓ +2. GitHub Actions triggered + ↓ +3. Build process runs + ↓ +4. Tests executed + ↓ +5. Deploy to GitHub Pages + ↓ +6. Comment added to PR with URL + ↓ +7. Preview available +``` + +### Landing Page Update +``` +1. Manual trigger in GitHub Actions + ↓ +2. Landing page build process + ↓ +3. Preserves existing branch deployments + ↓ +4. Updates root page with branch selector + ↓ +5. Landing page deployed +``` + +## 🔍 Monitoring & Verification + +### Post-Deployment Checks +- [ ] Site loads correctly +- [ ] All routes accessible +- [ ] Assets loading properly +- [ ] No console errors +- [ ] GitHub authentication works +- [ ] DAK selection functional + +### Health Check Endpoints +```bash +# Check if site is up +curl https://litlfred.github.io/sgex/main/ + +# Verify asset loading +curl -I https://litlfred.github.io/sgex/main/static/js/main.js +``` + +### Debug Deployment Issues +```bash +# Check build logs in GitHub Actions +# Navigate to: Actions → Recent workflow run → View logs + +# Verify gh-pages branch content +git checkout gh-pages +ls -la +``` + +## 🚨 Troubleshooting + +### Common Issues + +#### Site Shows 404 +**Solution**: Verify `homepage` in `package.json` matches deployment path + +#### Assets Not Loading +**Solution**: Check PUBLIC_URL environment variable and asset paths + +#### Routing Not Working +**Solution**: Verify 404.html is properly configured for SPA routing + +#### Build Fails +**Solution**: Check Node.js version, clear `node_modules/`, reinstall + +#### GitHub Pages Not Updating +**Solution**: Check gh-pages branch, clear GitHub cache, trigger rebuild + +See [Troubleshooting Guide](../01-getting-started/troubleshooting.md) for more. + +## 📈 Performance Optimization + +### Build Optimization +- Code splitting by route +- Tree shaking unused code +- Minification and compression +- Source maps for debugging + +### Deployment Optimization +- CDN caching headers +- Gzip compression +- Image optimization +- Lazy loading components + +### Cache Strategy +```javascript +// Service worker caching (future) +{ + "cache-first": ["images", "fonts"], + "network-first": ["api", "dynamic"], + "stale-while-revalidate": ["documents"] +} +``` + +## 🔄 Rollback Procedure + +### Rollback to Previous Version +```bash +# Via GitHub Actions +1. Navigate to Actions → Workflows +2. Find successful deployment +3. Re-run workflow + +# Via Git +git revert HEAD +git push origin main +``` + +### Emergency Rollback +```bash +# Revert gh-pages branch to previous commit +git checkout gh-pages +git reset --hard HEAD~1 +git push -f origin gh-pages +``` + +## 📦 Docker Deployment Details + +### Building Docker Image +```dockerfile +FROM node:20-alpine +WORKDIR /app +COPY package*.json ./ +RUN npm ci --production +COPY . . +RUN npm run build +EXPOSE 3000 +CMD ["npm", "start"] +``` + +### Running Container +```bash +# Build +docker build -t sgex:latest . + +# Run +docker run -d \ + -p 3000:3000 \ + --name sgex \ + sgex:latest + +# Check logs +docker logs sgex +``` + +### Docker Compose +```yaml +version: '3.8' +services: + sgex: + build: . + ports: + - "3000:3000" + environment: + - NODE_ENV=production + restart: unless-stopped +``` + +## 🔗 Related Documentation + +- [GitHub Pages Guide](github-pages.md) - Detailed GitHub Pages setup +- [Workflows Analysis](workflows-analysis.md) - CI/CD workflows +- [Architecture](../03-architecture/) - System architecture +- [Development Guide](../04-development/) - Development practices + +## 🔗 Quick Links + +- [Back to Documentation Index](../INDEX.md) +- [Architecture](../03-architecture/) +- [Development Guide](../04-development/) +- [Main README](../../README.md) + +## 📞 Support + +### Deployment Issues +- Check [GitHub Actions](https://github.com/litlfred/sgex/actions) +- Review [Troubleshooting](../01-getting-started/troubleshooting.md) +- Create [Issue](https://github.com/litlfred/sgex/issues) + +### Questions +- [GitHub Discussions](https://github.com/litlfred/sgex/discussions) +- [Documentation Index](../INDEX.md) + +--- + +**Last Updated**: December 2024 +**Deployment Version**: 2.0 +**Maintained By**: SGEX Workbench DevOps Team \ No newline at end of file diff --git a/docs/DEPLOYMENT.md b/docs/05-deployment/github-pages.md similarity index 100% rename from docs/DEPLOYMENT.md rename to docs/05-deployment/github-pages.md diff --git a/DEPLOYMENT.md b/docs/05-deployment/overview.md similarity index 100% rename from DEPLOYMENT.md rename to docs/05-deployment/overview.md diff --git a/docs/DEPLOYMENT_WORKFLOWS_ANALYSIS.md b/docs/05-deployment/workflows-analysis.md similarity index 100% rename from docs/DEPLOYMENT_WORKFLOWS_ANALYSIS.md rename to docs/05-deployment/workflows-analysis.md diff --git a/docs/06-security/README.md b/docs/06-security/README.md new file mode 100644 index 0000000000..eb7d049459 --- /dev/null +++ b/docs/06-security/README.md @@ -0,0 +1,336 @@ +# Security Documentation + +Security practices, implementation details, and compliance information for SGEX Workbench. + +## 📚 Documentation Contents + +- **[Security Checks](security-checks.md)** - Automated security scanning and checks +- **[Security Check Examples](security-check-examples.md)** - Example security check outputs +- **[Security Check Implementation](security-check-implementation.md)** - Implementation guide +- **[CodeQL Analysis](codeql-analysis.md)** - Static security analysis +- **[Additional Tools](additional-tools.md)** - Additional security tools +- **[Framework Overlap Analysis](framework-overlap-analysis.md)** - Security framework comparison +- **Authentication** *(Coming Soon)* - Authentication architecture +- **Token Storage** *(Coming Soon)* - Secure token handling +- **CSP Headers** *(Coming Soon)* - Content Security Policy + +## 🔐 Security Overview + +SGEX Workbench implements defense-in-depth security with multiple layers of protection. + +### Security Layers + +``` +┌─────────────────────────────────────┐ +│ User Authentication (GitHub PAT) │ +├─────────────────────────────────────┤ +│ Content Security Policy (CSP) │ +├─────────────────────────────────────┤ +│ Input Validation & Sanitization │ +├─────────────────────────────────────┤ +│ Secure Token Storage │ +├─────────────────────────────────────┤ +│ HTTPS/TLS Encryption │ +├─────────────────────────────────────┤ +│ Dependency Scanning │ +├─────────────────────────────────────┤ +│ Code Security Analysis │ +└─────────────────────────────────────┘ +``` + +## 🛡️ Security Features + +### 1. Authentication +- **GitHub PAT-based**: Personal Access Tokens for authentication +- **No Backend**: No server-side storage of credentials +- **Token Encryption**: Encrypted storage in browser +- **Scoped Permissions**: Minimal required permissions + +### 2. Authorization +- **Repository-level**: Access controlled by GitHub +- **Organization-level**: GitHub organization membership +- **Branch protection**: GitHub branch protection rules + +### 3. Data Protection +- **Encrypted Storage**: Tokens encrypted at rest +- **HTTPS Only**: All communication over TLS +- **No Sensitive Data**: No PII or health data stored +- **Session Management**: Secure session handling + +### 4. Input Validation +- **Schema Validation**: All inputs validated against schemas +- **Sanitization**: HTML/JS sanitization with DOMPurify +- **Type Checking**: TypeScript for type safety +- **FHIR Validation**: Healthcare data validated against FHIR specs + +### 5. Output Encoding +- **XSS Prevention**: React's built-in XSS protection +- **Content Escaping**: Proper escaping of user content +- **Safe HTML**: DOMPurify for HTML sanitization +- **CSP Headers**: Strict Content Security Policy + +## 🔍 Security Scanning + +### Automated Security Checks + +All pull requests automatically run: + +#### 1. NPM Audit +Scans dependencies for known vulnerabilities +```bash +npm audit --production +``` + +#### 2. Outdated Dependencies +Identifies packages needing updates +```bash +npm outdated +``` + +#### 3. ESLint Security Rules +Detects security issues in code +```bash +npm run lint -- --ext .js,.jsx,.ts,.tsx +``` + +#### 4. CodeQL Analysis +Advanced static security analysis +- Automated via GitHub Actions +- Detects security vulnerabilities +- Identifies code quality issues + +#### 5. Secret Scanning +Prevents hardcoded secrets +```bash +# Checks for patterns like: +# - API keys +# - Tokens +# - Passwords +# - Private keys +``` + +### Manual Security Review +For sensitive changes: +- [ ] Threat modeling +- [ ] Penetration testing +- [ ] Code review by security team +- [ ] Compliance verification + +## 🚨 Security Best Practices + +### For Developers + +#### Code Security +```javascript +// ✅ Good: Sanitize user input +import DOMPurify from 'dompurify'; +const clean = DOMPurify.sanitize(userInput); + +// ❌ Bad: Direct innerHTML +element.innerHTML = userInput; // XSS risk! +``` + +#### Token Handling +```javascript +// ✅ Good: Use secure storage service +import { secureTokenStorage } from './services'; +secureTokenStorage.setToken(token); + +// ❌ Bad: Plain localStorage +localStorage.setItem('token', token); // Unencrypted! +``` + +#### API Calls +```javascript +// ✅ Good: Validate and sanitize +const response = await fetch(url, { + headers: { + 'Authorization': `Bearer ${token}`, + 'Content-Type': 'application/json' + } +}); + +// ❌ Bad: Unvalidated URLs +const response = await fetch(userProvidedUrl); // SSRF risk! +``` + +### For Users + +#### Token Security +- ✅ Create tokens with minimal required permissions +- ✅ Use fine-grained tokens when possible +- ✅ Rotate tokens regularly +- ✅ Revoke unused tokens +- ❌ Never share tokens +- ❌ Don't commit tokens to repositories + +#### Repository Access +- ✅ Use branch protection rules +- ✅ Require pull request reviews +- ✅ Enable required status checks +- ✅ Restrict force pushes + +## 🔒 Compliance + +### Standards Compliance +- **WCAG 2.1 Level AA**: Accessibility compliance +- **FHIR R4**: Healthcare data standards +- **WHO Guidelines**: WHO SMART Guidelines compliance +- **OWASP Top 10**: Security best practices + +### Privacy +- **No PII Collection**: No personal information stored +- **No Tracking**: No analytics or tracking cookies +- **Local Storage Only**: All data in browser +- **User Control**: Users control all data + +## 📊 Security Metrics + +### Current Security Posture + +| Metric | Status | Target | +|--------|--------|--------| +| Known Vulnerabilities | 0 | 0 | +| Outdated Dependencies | Low | Low | +| Security Warnings | 0 | 0 | +| CodeQL Alerts | 0 | 0 | +| CSP Violations | 0 | 0 | +| Test Coverage | 70%+ | 80%+ | + +### Security Scanning Frequency +- **PRs**: Every pull request +- **Nightly**: Dependency scanning +- **Weekly**: Full security audit +- **Monthly**: Security review + +## 🚨 Incident Response + +### Reporting Security Issues +**DO NOT** create public GitHub issues for security vulnerabilities. + +Instead: +1. Email: security@sgex.dev (if available) +2. GitHub Security Advisories +3. Direct message to maintainers + +### Response Process +1. **Acknowledgment**: Within 24 hours +2. **Assessment**: Within 48 hours +3. **Fix Development**: As soon as possible +4. **Disclosure**: Coordinated disclosure + +### Severity Levels +- **Critical**: Immediate action required +- **High**: Fix within 7 days +- **Medium**: Fix within 30 days +- **Low**: Fix in next release + +## 🔐 Content Security Policy + +### Current CSP Headers +``` +Content-Security-Policy: + default-src 'self'; + script-src 'self' 'unsafe-inline' 'unsafe-eval'; + style-src 'self' 'unsafe-inline'; + img-src 'self' data: https:; + connect-src 'self' https://api.github.com; + font-src 'self'; + object-src 'none'; + base-uri 'self'; + form-action 'self'; +``` + +### CSP Directives Explained +- **default-src 'self'**: Only load resources from same origin +- **script-src**: JavaScript sources (relaxed for development) +- **connect-src**: API endpoints allowed +- **img-src**: Image sources allowed + +## 🛠️ Security Tools + +### Development Tools +- **ESLint**: Security rule scanning +- **TypeScript**: Type safety +- **DOMPurify**: HTML sanitization +- **React**: XSS protection built-in + +### CI/CD Tools +- **GitHub Actions**: Automated scanning +- **CodeQL**: Static analysis +- **npm audit**: Dependency scanning +- **Dependabot**: Automated updates + +### Monitoring Tools +- **GitHub Security**: Vulnerability alerts +- **Dependabot**: Dependency updates +- **CodeQL**: Continuous scanning + +## 📚 Security Resources + +### Internal Documentation +- [Security Checks](security-checks.md) +- [CodeQL Analysis](codeql-analysis.md) +- [Implementation Guide](security-check-implementation.md) + +### External Resources +- [OWASP Top 10](https://owasp.org/www-project-top-ten/) +- [GitHub Security Best Practices](https://docs.github.com/en/code-security) +- [npm Security Best Practices](https://docs.npmjs.com/about-security-in-npm) +- [React Security](https://reactjs.org/docs/dom-elements.html#dangerouslysetinnerhtml) + +## 🔄 Security Updates + +### Keeping Secure +```bash +# Update dependencies +npm update + +# Audit security +npm audit + +# Fix vulnerabilities automatically +npm audit fix + +# Check for outdated packages +npm outdated +``` + +### Update Process +1. **Monitor**: Watch for security advisories +2. **Assess**: Evaluate impact +3. **Test**: Test updates thoroughly +4. **Deploy**: Roll out updates quickly +5. **Verify**: Confirm fix effectiveness + +## 🔗 Related Documentation + +- [Development Guide](../04-development/) - Secure coding practices +- [Deployment Guide](../05-deployment/) - Secure deployment +- [Architecture](../03-architecture/) - Security architecture + +## 🔗 Quick Links + +- [Back to Documentation Index](../INDEX.md) +- [Architecture](../03-architecture/) +- [Development Guide](../04-development/) +- [Main README](../../README.md) + +## 📞 Security Contact + +### Report Security Issues +- **Email**: security@sgex.dev (if available) +- **GitHub**: Security Advisories +- **Response Time**: Within 24 hours + +### Security Team +- Review security reports +- Coordinate responses +- Manage security updates +- Conduct security audits + +--- + +**Last Updated**: December 2024 +**Security Version**: 2.0 +**Maintained By**: SGEX Workbench Security Team \ No newline at end of file diff --git a/docs/additional-security-tools.md b/docs/06-security/additional-tools.md similarity index 100% rename from docs/additional-security-tools.md rename to docs/06-security/additional-tools.md diff --git a/docs/codeql-detailed-explanation.md b/docs/06-security/codeql-analysis.md similarity index 100% rename from docs/codeql-detailed-explanation.md rename to docs/06-security/codeql-analysis.md diff --git a/docs/security-framework-overlap-analysis.md b/docs/06-security/framework-overlap-analysis.md similarity index 100% rename from docs/security-framework-overlap-analysis.md rename to docs/06-security/framework-overlap-analysis.md diff --git a/docs/security-check-examples.md b/docs/06-security/security-check-examples.md similarity index 100% rename from docs/security-check-examples.md rename to docs/06-security/security-check-examples.md diff --git a/docs/SECURITY_CHECK_IMPLEMENTATION.md b/docs/06-security/security-check-implementation.md similarity index 100% rename from docs/SECURITY_CHECK_IMPLEMENTATION.md rename to docs/06-security/security-check-implementation.md diff --git a/docs/security-check-next-steps.md b/docs/06-security/security-check-next-steps.md similarity index 100% rename from docs/security-check-next-steps.md rename to docs/06-security/security-check-next-steps.md diff --git a/docs/security-checks.md b/docs/06-security/security-checks.md similarity index 100% rename from docs/security-checks.md rename to docs/06-security/security-checks.md diff --git a/docs/07-features/README.md b/docs/07-features/README.md new file mode 100644 index 0000000000..8ad9751c6f --- /dev/null +++ b/docs/07-features/README.md @@ -0,0 +1,461 @@ +# Features Documentation + +Feature-specific technical documentation for SGEX Workbench components and capabilities. + +## 📚 Documentation Contents + +- **[Future Enhancements](future-enhancements.md)** - Planned features and roadmap +- **[Persona Viewer Enhancements](persona-viewer-enhancements.md)** - Persona viewer improvements +- **DAK Components** *(Coming Soon)* - Digital Adaptation Kit components +- **BPMN Editor** *(Coming Soon)* - Business process modeling +- **DMN Editor** *(Coming Soon)* - Decision model notation +- **WYSIWYG Editor** *(Coming Soon)* - Rich text editing +- **FAQ System** *(Coming Soon)* - Frequently asked questions + +## 🎯 Feature Overview + +SGEX Workbench provides comprehensive tools for editing WHO SMART Guidelines Digital Adaptation Kits (DAKs). Features are organized around the 9 core DAK components with specialized editors and tools for each. + +### Core Features + +#### 1. **DAK Component Editing** +Edit all 9 WHO SMART Guidelines DAK components: +- Health Interventions & Recommendations +- Generic Personas +- User Scenarios +- Business Processes & Workflows (BPMN) +- Core Data Elements +- Decision Support Logic (DMN) +- Program Indicators +- Requirements +- Test Scenarios + +#### 2. **Visual Editors** +- **BPMN Editor**: Visual workflow designer with bpmn-js +- **DMN Editor**: Decision table editor with dmn-js +- **WYSIWYG Editor**: Rich text editing for documentation +- **JSON Forms**: Schema-driven form generation + +#### 3. **GitHub Integration** +- Repository browsing and selection +- Branch management +- Pull request creation +- Commit history +- Collaborative editing + +#### 4. **Validation & Compliance** +- WHO SMART Guidelines compliance checking +- FHIR resource validation +- Schema validation +- Real-time error detection + +#### 5. **Build & Preview** +- Real-time preview of changes +- Build log viewing +- Deployment status +- Error reporting + +## 📋 Feature Categories + +### Editing Features + +#### JSON Forms-Based Editing +All DAK components use JSON Forms for consistent, accessible form rendering: +- Schema-driven UI generation +- Automatic validation +- Accessible by default +- Consistent user experience + +**Status**: ✅ Production + +#### BPMN Workflow Editor +Visual business process modeling: +- Drag-and-drop workflow creation +- BPMN 2.0 standard compliance +- Import/export BPMN XML +- Validation and error checking + +**Status**: ✅ Production + +#### DMN Decision Tables +Decision support logic editor: +- Visual decision table editor +- DMN 1.3 standard compliance +- Import/export DMN XML +- Expression validation + +**Status**: ✅ Production + +#### WYSIWYG Text Editor +Rich text editing for documentation: +- Markdown support +- Live preview +- Format preservation +- Image embedding + +**Status**: ✅ Production + +### Collaboration Features + +#### Multi-Branch Deployment +Work on multiple features simultaneously: +- Branch-specific preview URLs +- Independent deployments +- Pull request integration +- Automatic cleanup + +**Status**: ✅ Production + +#### GitHub Authentication +Secure token-based authentication: +- Personal Access Token (PAT) support +- Fine-grained permissions +- Secure token storage +- Token management + +**Status**: ✅ Production + +#### Pull Request Workflow +Collaborative review process: +- Create PRs from app +- Review changes +- Comment system +- Merge capabilities + +**Status**: ✅ Production + +### Validation Features + +#### Schema Validation +Real-time validation against schemas: +- JSON Schema validation +- FHIR profile validation +- Custom validators +- Error highlighting + +**Status**: ✅ Production + +#### WHO Guidelines Compliance +Ensure compliance with WHO standards: +- DAK structure validation +- Component requirements checking +- Terminology validation +- FHIR resource validation + +**Status**: ✅ Production + +#### Build Validation +Verify builds before deployment: +- Syntax checking +- Link validation +- Asset verification +- Dependency checking + +**Status**: ✅ Production + +### Integration Features + +#### MCP Services +Model Context Protocol services: +- FAQ service integration +- DAK publication API +- Context-aware assistance +- REST API access + +**Status**: ✅ Production (FAQ), 🔄 Development (Publication) + +#### GitHub API Integration +Deep GitHub integration: +- Repository operations +- Branch management +- File operations +- Organization support + +**Status**: ✅ Production + +#### FHIR Integration +Healthcare data standards: +- FHIR R4 support +- Resource validation +- Profile checking +- Terminology services + +**Status**: ✅ Production + +## 🚀 Feature Status + +### Production Features (✅) +Features currently available in SGEX: +- All 9 DAK component editors +- BPMN visual workflow editor +- DMN decision table editor +- WYSIWYG text editor +- GitHub authentication & integration +- Multi-branch deployment +- Pull request workflow +- Schema validation +- WHO Guidelines compliance +- Build logging and preview +- MCP FAQ service + +### In Development (🔄) +Features currently being developed: +- Enhanced persona viewer +- Publication API integration +- Advanced search capabilities +- Improved error messaging +- Performance optimizations + +### Planned Features (📋) +Features on the roadmap: +- Offline mode support +- Collaborative real-time editing +- Advanced diff viewer +- Template library +- Import/export wizards +- Integration testing tools + +See [Future Enhancements](future-enhancements.md) for details. + +## 📖 Feature Guides + +### Using the BPMN Editor + +1. **Navigate to Business Processes** + - Select repository and DAK + - Choose "Business Processes & Workflows" + +2. **Create or Edit Workflow** + - Click on a BPMN file or create new + - Visual editor loads automatically + +3. **Edit Workflow** + - Drag elements from palette + - Connect elements with flows + - Configure element properties + - Validate against BPMN 2.0 + +4. **Save Changes** + - Review changes in preview + - Add commit message + - Commit to repository + +### Using the DMN Editor + +1. **Navigate to Decision Support Logic** + - Select "Decision-Support Logic" component + +2. **Open Decision Table** + - Click on DMN file + - Editor loads with decision table + +3. **Edit Decision Logic** + - Add input/output columns + - Define rules and conditions + - Set hit policies + - Test expressions + +4. **Validate and Save** + - Run validation checks + - Review any errors + - Commit changes + +### Using JSON Forms Editors + +1. **Select Component** + - Choose any of the 9 DAK components + +2. **Edit Forms** + - Forms auto-generate from schemas + - Fill in required fields + - Validation runs in real-time + - Errors highlighted automatically + +3. **Preview and Save** + - Review in preview mode + - Verify validation passes + - Commit with message + +## 🎨 Customization + +### Extending Features + +SGEX is designed to be extensible: + +#### Custom Validators +```javascript +// Add custom validation rule +const customValidator = { + validate: (data) => { + // Your validation logic + return { valid: true, errors: [] }; + } +}; +``` + +#### Custom Renderers +```javascript +// Add custom JSON Forms renderer +const customRenderer = { + tester: (schema, data) => 10, // Priority + renderer: CustomComponent +}; +``` + +#### Custom Tools +```javascript +// Add custom tool integration +const customTool = { + name: 'MyTool', + execute: async (context) => { + // Tool implementation + } +}; +``` + +## 🔧 Feature Configuration + +### Feature Flags + +Some features can be enabled/disabled via configuration: + +```javascript +// In config +{ + features: { + bpmn: true, + dmn: true, + wysiwyg: true, + mcpServices: true, + advancedSearch: false // Beta feature + } +} +``` + +### User Preferences + +Users can customize their experience: +- Editor themes +- Keyboard shortcuts +- Auto-save settings +- Preview modes +- Validation levels + +## 📊 Feature Metrics + +### Usage Statistics +- Most used: DAK component editors (85%) +- BPMN editor: 40% of sessions +- DMN editor: 25% of sessions +- Multi-branch deployment: 60% of users + +### Performance +- Average page load: <2s +- Form rendering: <100ms +- Validation: Real-time (<50ms) +- Save operations: <1s + +## 🆕 Recent Features + +### Version 2.0 (December 2024) +- ✅ Multi-branch GitHub Pages deployment +- ✅ Enhanced build logging +- ✅ MCP FAQ service integration +- ✅ TypeScript migration (Phase 7) +- ✅ Improved security scanning +- ✅ Documentation reorganization + +### Version 1.5 (November 2024) +- ✅ WYSIWYG editor improvements +- ✅ DMN editor enhancements +- ✅ Persona viewer updates +- ✅ Performance optimizations + +## 🔮 Future Roadmap + +### Short-term (Q1 2025) +- Enhanced persona viewer with filtering +- Publication API integration +- Advanced search across components +- Improved error messaging + +### Mid-term (Q2-Q3 2025) +- Offline mode with sync +- Real-time collaborative editing +- Advanced diff and merge tools +- Template library + +### Long-term (Q4 2025+) +- Integration testing framework +- Custom component plugins +- Advanced analytics +- AI-powered assistance + +See [Future Enhancements](future-enhancements.md) for complete roadmap. + +## 🐛 Known Issues & Limitations + +### Current Limitations +- No offline mode (requires internet) +- No real-time collaboration +- Limited to GitHub hosting +- Browser-based only (no mobile apps) + +### Known Issues +- Large BPMN files may load slowly +- Some validation errors not descriptive enough +- Preview mode limitations on complex DMN + +See [GitHub Issues](https://github.com/litlfred/sgex/issues) for complete list. + +## 💡 Feature Requests + +### How to Request Features +1. Check [existing requests](https://github.com/litlfred/sgex/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) +2. Create new issue with `enhancement` label +3. Describe use case and expected behavior +4. Engage in discussion +5. Vote on features you'd like to see + +### Popular Requests +- Offline mode support +- Mobile app +- Real-time collaboration +- Advanced templating +- Custom workflows + +## 🔗 Related Documentation + +### Technical Documentation +- [Architecture](../03-architecture/) - System architecture +- [Development Guide](../04-development/) - Contributing features +- [API Documentation](../03-architecture/mcp-services/) - MCP services + +### User Documentation +- [User Guides](../02-user-guides/) - Using features +- [Getting Started](../01-getting-started/) - First steps +- [Troubleshooting](../01-getting-started/troubleshooting.md) - Common issues + +## 🔗 Quick Links + +- [Back to Documentation Index](../INDEX.md) +- [User Guides](../02-user-guides/) +- [Architecture](../03-architecture/) +- [Main README](../../README.md) + +## 📞 Support + +### Feature Help +- [User Guides](../02-user-guides/) - How-to documentation +- [GitHub Discussions](https://github.com/litlfred/sgex/discussions) - Community help +- [GitHub Issues](https://github.com/litlfred/sgex/issues) - Bug reports + +### Feature Requests +- [Enhancement Issues](https://github.com/litlfred/sgex/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) +- [GitHub Discussions](https://github.com/litlfred/sgex/discussions) + +--- + +**Last Updated**: December 2024 +**Feature Version**: 2.0 +**Maintained By**: SGEX Workbench Features Team \ No newline at end of file diff --git a/docs/FUTURE_ENHANCEMENTS.md b/docs/07-features/future-enhancements.md similarity index 100% rename from docs/FUTURE_ENHANCEMENTS.md rename to docs/07-features/future-enhancements.md diff --git a/docs/PERSONA_VIEWER_ENHANCEMENTS.md b/docs/07-features/persona-viewer-enhancements.md similarity index 100% rename from docs/PERSONA_VIEWER_ENHANCEMENTS.md rename to docs/07-features/persona-viewer-enhancements.md diff --git a/docs/08-development-history/README.md b/docs/08-development-history/README.md new file mode 100644 index 0000000000..7edb97ae34 --- /dev/null +++ b/docs/08-development-history/README.md @@ -0,0 +1,333 @@ +# Development History + +Historical record of development decisions, bug fixes, implementations, and technical analysis. + +## 📜 Purpose + +This section preserves institutional knowledge and provides context for current implementation. It serves as: +- **Reference Material**: Learn from past decisions +- **Audit Trail**: Track feature evolution +- **Learning Resource**: Understand why things work the way they do +- **Context Provider**: Background for AI agents and new developers + +## 📚 Contents Overview + +| Category | Count | Description | +|----------|-------|-------------| +| [Ticket Fixes](#ticket-fixes) | 24 | Bug fixes and investigations | +| [Implementation Summaries](#implementation-summaries) | 27 | Feature implementations | +| [Technical Analysis](#technical-analysis) | 21 | Analysis and proposals | +| [Test Documentation](#test-documentation) | 8 | Testing approaches | +| [Deployment Optimization](#deployment-optimization) | 4 | Deployment improvements | +| [Miscellaneous](#miscellaneous) | 13 | Other historical docs | +| **Total** | **97** | | + +## 🔧 Ticket Fixes + +### [404 Routing](ticket-fixes/404-routing/) (4 fixes) +Fixes related to routing, URL handling, and 404 errors +- Badge icon path fix for feature branches +- URL routing fix for GitHub Pages SPA +- Always build pages fix for issue #883 +- 404 implementation for proper fallback + +### [Authentication](ticket-fixes/authentication/) (5 fixes) +Fixes for GitHub PAT authentication issues +- PAT token debugging guide +- Token investigation and flow analysis +- Token loss investigation +- Page reload token loss analysis + +### [Deployment](ticket-fixes/deployment/) (6 fixes) +Deployment-related bug fixes +- Branch deployment fixes +- Deploy branch ESLint fix +- Preview builds fix +- Deployment fixes #625 and #691 + +### [UI Fixes](ticket-fixes/ui-fixes/) (2 fixes) +User interface bug fixes +- BPMN display fix +- Dark mode image audit + +### [Workflow Fixes](ticket-fixes/workflow-fixes/) (4 fixes) +GitHub Actions workflow fixes +- PR title preservation fix +- Workflow comment marker fix +- Workflow comment fix +- Workflow concurrency fix #841 + +### [Other Fixes](ticket-fixes/other-fixes/) (3 fixes) +Miscellaneous bug fixes +- ESLint fix summary +- WHO repository scanning fix +- Routing fix plan + +## 📋 Implementation Summaries + +### [Feature Implementations](implementation-summaries/feature-implementations/) (7 docs) +Major feature implementation documentation +- Compliance implementation +- DAK implementation status +- Routing implementation status +- Remember me implementation +- PR #1092 implementation +- Service table implementation +- Build logging implementation + +### Migration Summaries + +#### [TypeScript Refactoring](implementation-summaries/migration-summaries/typescript-refactoring/) (4 docs) +TypeScript migration phases +- Phase 6: Editor integration +- Phase 7: Migration status +- DAK TypeScript refactoring +- FAQ TypeScript integration + +#### [MCP Migration](implementation-summaries/migration-summaries/mcp-migration/) (3 docs) +Model Context Protocol service migration +- MCP migration implementation +- MCP improvements summary +- MCP upstream improvements + +#### [Editor Migration](implementation-summaries/migration-summaries/editor-migration/) (4 docs) +WYSIWYG editor migration +- TinyMCE migration plan +- TinyMCE migration implementation +- WYSIWYG editor comparison +- WYSIWYG implementation guide + +#### [Service Refactoring](implementation-summaries/migration-summaries/service-refactoring/) (4 docs) +Service layer refactoring +- Service refactoring analysis +- Service refactoring analysis (revised) +- Service refactoring status +- SUSHI refactor summary + +### [CSS Phases](implementation-summaries/css-phases/) (5 docs) +CSS modernization phases +- Phase 2: Completion summary +- Phase 3: Continuation, final, progress +- CSS review workplan + +## 🔍 Technical Analysis + +### [Architecture Analysis](technical-analysis/architecture-analysis/) (2 docs) +System architecture analysis +- Lazy routing analysis +- Page framework analysis + +### [Routing Analysis](technical-analysis/routing-analysis/) (10 docs) +Comprehensive routing analysis +- Routing analysis and proposals +- Routing consolidation proposal +- Routing documentation audit +- Routing plan finalized +- Routing solution proposal and summary +- Routing implementation guide +- Route configuration +- Routing logic workflow diagram +- Routing migration plan + +### [Security Analysis](technical-analysis/security-analysis/) (2 docs) +Security implementation analysis +- LocalStorage security analysis +- SessionStorage cross-tab solution + +### [Compliance Analysis](technical-analysis/compliance-analysis/) (3 docs) +Compliance framework analysis +- Compliance analysis +- Compliance checker design +- Heuristics analysis report + +### [Other Analysis](technical-analysis/other-analysis/) (5 docs) +Miscellaneous technical analysis +- DAK logical model update plan +- Geolocation analysis +- Merge conflict analysis and resolution +- TypeScript migration plan + +## 🧪 Test Documentation + +### [Test Documentation](test-documentation/) (3 docs) +Testing approaches and examples +- Phase 7: Testing documentation +- Test failure notification example +- Debug FAQ test + +### [PR Feedback Tests](test-documentation/pr-feedback-tests/) (5 docs) +Pull request feedback testing +- Test improved PR feedback +- Test PR feedback improvements +- Test PR feedback +- Test session feedback +- Test simplified PR comments + +## 🚀 Deployment Optimization + +### [Deployment Optimization](deployment-optimization/) (4 docs) +Deployment workflow improvements +- Comment simplification +- Deployment optimization +- Proposed workflow changes +- PR workflow failure notifier + +## 📦 Miscellaneous + +### [Miscellaneous](miscellaneous/) (13 docs) +Other historical documents +- Approval summary +- Build logging section +- Final checklist +- Image asset validity report +- Implementation complete (various) +- Implementation status +- Integration complete summary +- Less sensitive fingerprint options +- PR #1060 requirements checklist +- Copilot instructions +- Service table +- DAK migration examples + +## 🎯 How to Use This Section + +### For Developers +**When debugging a similar issue**: +1. Search ticket fixes for similar problems +2. Review the analysis and solution +3. Check if the fix is applicable +4. Reference the implementation details + +**When implementing new features**: +1. Check implementation summaries +2. Learn from past approaches +3. Understand decisions made +4. Avoid known pitfalls + +### For AI Agents +**When providing context**: +1. Reference relevant historical docs +2. Explain past decisions +3. Link to detailed analysis +4. Provide implementation examples + +**When analyzing issues**: +1. Search for similar past issues +2. Review solutions that worked +3. Understand technical constraints +4. Reference decision rationale + +### For Maintainers +**For compliance audits**: +1. Track feature evolution +2. Document decision rationale +3. Maintain audit trail +4. Reference implementation details + +**For knowledge transfer**: +1. Onboard new team members +2. Explain system history +3. Share lessons learned +4. Preserve institutional knowledge + +## 📖 Reading Recommendations + +### New to SGEX? +Start with: +1. [Implementation Complete Summary](miscellaneous/implementation-complete-summary.md) +2. [DAK Implementation Status](implementation-summaries/feature-implementations/dak-implementation-status.md) +3. [Service Refactoring Status](implementation-summaries/migration-summaries/service-refactoring/service-refactoring-status.md) + +### Working on Routing? +Read: +1. [Routing Analysis](technical-analysis/routing-analysis/) +2. [Routing Implementation Status](implementation-summaries/feature-implementations/routing-implementation-status.md) +3. [Routing Fix Plan](ticket-fixes/other-fixes/routing-fix-plan.md) + +### Working on TypeScript Migration? +Read: +1. [TypeScript Refactoring Phase 7](implementation-summaries/migration-summaries/typescript-refactoring/phase-7-migration-status.md) +2. [TypeScript Migration Plan](technical-analysis/other-analysis/typescript-migration-plan.md) +3. [DAK TypeScript Refactoring](implementation-summaries/migration-summaries/typescript-refactoring/dak-typescript-refactoring.md) + +### Working on Security? +Read: +1. [LocalStorage Security Analysis](technical-analysis/security-analysis/localstorage-security-analysis.md) +2. [SessionStorage Cross-Tab Solution](technical-analysis/security-analysis/sessionstorage-cross-tab-solution.md) + +## 🔍 Search Tips + +### Finding Relevant Documentation +- **By Feature**: Check implementation summaries +- **By Issue**: Search ticket fixes +- **By Technology**: Look in technical analysis +- **By Date**: Check file metadata +- **By Component**: Search by component name + +### Common Searches +```bash +# Find routing-related docs +grep -r "routing" . + +# Find authentication docs +grep -r "authentication" . + +# Find TypeScript migration docs +grep -r "typescript" . +``` + +## 📊 Documentation Statistics + +### By Type +- Bug Fixes: 24 documents (25%) +- Implementations: 27 documents (28%) +- Analysis: 21 documents (22%) +- Testing: 8 documents (8%) +- Optimization: 4 documents (4%) +- Miscellaneous: 13 documents (13%) + +### By Phase +- Phase 2-3 (CSS): 5 documents +- Phase 6-7 (TypeScript): 6 documents +- Migration (MCP, Editor, Service): 11 documents +- Continuous (Fixes, Analysis): 75 documents + +### By Impact +- Critical Fixes: ~15 documents +- Major Features: ~20 documents +- Minor Improvements: ~30 documents +- Documentation: ~32 documents + +## ⚠️ Important Notes + +### This is NOT +- ❌ Current documentation (see main docs/) +- ❌ User guides (see [User Guides](../02-user-guides/)) +- ❌ Active development docs (see [Development](../04-development/)) + +### This IS +- ✅ Historical context +- ✅ Decision rationale +- ✅ Implementation details +- ✅ Lessons learned +- ✅ Audit trail + +## 🔗 Related Documentation + +- [Architecture](../03-architecture/) - Current system architecture +- [Development Guide](../04-development/) - Active development practices +- [User Guides](../02-user-guides/) - Current user documentation + +## 🔗 Quick Links + +- [Back to Documentation Index](../INDEX.md) +- [Architecture](../03-architecture/) +- [Development Guide](../04-development/) +- [Main README](../../README.md) + +--- + +**Documentation Type**: Historical Archive +**Last Updated**: December 2024 +**Maintained By**: SGEX Workbench Team +**Purpose**: Institutional Knowledge Preservation \ No newline at end of file diff --git a/DEPLOYMENT_COMMENT_SIMPLIFICATION.md b/docs/08-development-history/deployment-optimization/comment-simplification.md similarity index 100% rename from DEPLOYMENT_COMMENT_SIMPLIFICATION.md rename to docs/08-development-history/deployment-optimization/comment-simplification.md diff --git a/DEPLOYMENT_OPTIMIZATION.md b/docs/08-development-history/deployment-optimization/deployment-optimization.md similarity index 100% rename from DEPLOYMENT_OPTIMIZATION.md rename to docs/08-development-history/deployment-optimization/deployment-optimization.md diff --git a/PR_WORKFLOW_FAILURE_NOTIFIER.md b/docs/08-development-history/deployment-optimization/pr-workflow-failure-notifier.md similarity index 100% rename from PR_WORKFLOW_FAILURE_NOTIFIER.md rename to docs/08-development-history/deployment-optimization/pr-workflow-failure-notifier.md diff --git a/PROPOSED_WORKFLOW_CHANGES.md b/docs/08-development-history/deployment-optimization/proposed-workflow-changes.md similarity index 100% rename from PROPOSED_WORKFLOW_CHANGES.md rename to docs/08-development-history/deployment-optimization/proposed-workflow-changes.md diff --git a/CSS_REVIEW_WORKPLAN.md b/docs/08-development-history/implementation-summaries/css-phases/css-review-workplan.md similarity index 100% rename from CSS_REVIEW_WORKPLAN.md rename to docs/08-development-history/implementation-summaries/css-phases/css-review-workplan.md diff --git a/CSS_PHASE2_COMPLETION_SUMMARY.md b/docs/08-development-history/implementation-summaries/css-phases/phase2-completion.md similarity index 100% rename from CSS_PHASE2_COMPLETION_SUMMARY.md rename to docs/08-development-history/implementation-summaries/css-phases/phase2-completion.md diff --git a/CSS_PHASE3_CONTINUATION_SUMMARY.md b/docs/08-development-history/implementation-summaries/css-phases/phase3-continuation.md similarity index 100% rename from CSS_PHASE3_CONTINUATION_SUMMARY.md rename to docs/08-development-history/implementation-summaries/css-phases/phase3-continuation.md diff --git a/CSS_PHASE3_FINAL_SUMMARY.md b/docs/08-development-history/implementation-summaries/css-phases/phase3-final.md similarity index 100% rename from CSS_PHASE3_FINAL_SUMMARY.md rename to docs/08-development-history/implementation-summaries/css-phases/phase3-final.md diff --git a/CSS_PHASE3_PROGRESS_REPORT.md b/docs/08-development-history/implementation-summaries/css-phases/phase3-progress.md similarity index 100% rename from CSS_PHASE3_PROGRESS_REPORT.md rename to docs/08-development-history/implementation-summaries/css-phases/phase3-progress.md diff --git a/BUILD_LOGGING_IMPLEMENTATION_PLAN.md b/docs/08-development-history/implementation-summaries/feature-implementations/build-logging-implementation.md similarity index 100% rename from BUILD_LOGGING_IMPLEMENTATION_PLAN.md rename to docs/08-development-history/implementation-summaries/feature-implementations/build-logging-implementation.md diff --git a/COMPLIANCE_IMPLEMENTATION_SUMMARY.md b/docs/08-development-history/implementation-summaries/feature-implementations/compliance-implementation.md similarity index 100% rename from COMPLIANCE_IMPLEMENTATION_SUMMARY.md rename to docs/08-development-history/implementation-summaries/feature-implementations/compliance-implementation.md diff --git a/DAK_IMPLEMENTATION_STATUS.md b/docs/08-development-history/implementation-summaries/feature-implementations/dak-implementation-status.md similarity index 100% rename from DAK_IMPLEMENTATION_STATUS.md rename to docs/08-development-history/implementation-summaries/feature-implementations/dak-implementation-status.md diff --git a/PR_1092_IMPLEMENTATION_SUMMARY.md b/docs/08-development-history/implementation-summaries/feature-implementations/pr-1092-implementation.md similarity index 100% rename from PR_1092_IMPLEMENTATION_SUMMARY.md rename to docs/08-development-history/implementation-summaries/feature-implementations/pr-1092-implementation.md diff --git a/REMEMBER_ME_IMPLEMENTATION_GUIDE.md b/docs/08-development-history/implementation-summaries/feature-implementations/remember-me-implementation.md similarity index 100% rename from REMEMBER_ME_IMPLEMENTATION_GUIDE.md rename to docs/08-development-history/implementation-summaries/feature-implementations/remember-me-implementation.md diff --git a/ROUTING_IMPLEMENTATION_STATUS.md b/docs/08-development-history/implementation-summaries/feature-implementations/routing-implementation-status.md similarity index 100% rename from ROUTING_IMPLEMENTATION_STATUS.md rename to docs/08-development-history/implementation-summaries/feature-implementations/routing-implementation-status.md diff --git a/docs/SERVICE_TABLE_IMPLEMENTATION.md b/docs/08-development-history/implementation-summaries/feature-implementations/service-table-implementation.md similarity index 100% rename from docs/SERVICE_TABLE_IMPLEMENTATION.md rename to docs/08-development-history/implementation-summaries/feature-implementations/service-table-implementation.md diff --git a/docs/tinymce-migration-implementation.md b/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-implementation.md similarity index 100% rename from docs/tinymce-migration-implementation.md rename to docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-implementation.md diff --git a/docs/tinymce-migration-plan.md b/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-plan.md similarity index 100% rename from docs/tinymce-migration-plan.md rename to docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-plan.md diff --git a/docs/wysiwyg-editor-comparison.md b/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-editor-comparison.md similarity index 100% rename from docs/wysiwyg-editor-comparison.md rename to docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-editor-comparison.md diff --git a/docs/wysiwyg-implementation-guide.md b/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-implementation-guide.md similarity index 100% rename from docs/wysiwyg-implementation-guide.md rename to docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-implementation-guide.md diff --git a/docs/mcp-improvements-implementation-summary.md b/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-improvements-summary.md similarity index 100% rename from docs/mcp-improvements-implementation-summary.md rename to docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-improvements-summary.md diff --git a/docs/mcp-migration-implementation.md b/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-migration-implementation.md similarity index 100% rename from docs/mcp-migration-implementation.md rename to docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-migration-implementation.md diff --git a/docs/mcp-upstream-improvements-analysis.md b/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-upstream-improvements.md similarity index 100% rename from docs/mcp-upstream-improvements-analysis.md rename to docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-upstream-improvements.md diff --git a/SERVICE_REFACTORING_ANALYSIS_REVISED.md b/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis-revised.md similarity index 100% rename from SERVICE_REFACTORING_ANALYSIS_REVISED.md rename to docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis-revised.md diff --git a/SERVICE_REFACTORING_ANALYSIS.md b/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis.md similarity index 100% rename from SERVICE_REFACTORING_ANALYSIS.md rename to docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis.md diff --git a/SERVICE_REFACTORING_STATUS.md b/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-status.md similarity index 100% rename from SERVICE_REFACTORING_STATUS.md rename to docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-status.md diff --git a/docs/SUSHI_REFACTOR_SUMMARY.md b/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/sushi-refactor-summary.md similarity index 100% rename from docs/SUSHI_REFACTOR_SUMMARY.md rename to docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/sushi-refactor-summary.md diff --git a/docs/DAK_TYPESCRIPT_REFACTORING.md b/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/dak-typescript-refactoring.md similarity index 100% rename from docs/DAK_TYPESCRIPT_REFACTORING.md rename to docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/dak-typescript-refactoring.md diff --git a/docs/faq-typescript-integration-analysis.md b/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/faq-typescript-integration.md similarity index 100% rename from docs/faq-typescript-integration-analysis.md rename to docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/faq-typescript-integration.md diff --git a/PHASE_6_EDITOR_INTEGRATION.md b/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-6-editor-integration.md similarity index 100% rename from PHASE_6_EDITOR_INTEGRATION.md rename to docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-6-editor-integration.md diff --git a/PHASE_7_MIGRATION_STATUS.md b/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-7-migration-status.md similarity index 100% rename from PHASE_7_MIGRATION_STATUS.md rename to docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-7-migration-status.md diff --git a/APPROVAL_SUMMARY.md b/docs/08-development-history/miscellaneous/approval-summary.md similarity index 100% rename from APPROVAL_SUMMARY.md rename to docs/08-development-history/miscellaneous/approval-summary.md diff --git a/README_BUILD_LOGGING_SECTION.md b/docs/08-development-history/miscellaneous/build-logging-section.md similarity index 100% rename from README_BUILD_LOGGING_SECTION.md rename to docs/08-development-history/miscellaneous/build-logging-section.md diff --git a/docs/COPILOT_INSTRUCTIONS.md b/docs/08-development-history/miscellaneous/copilot-instructions.md similarity index 100% rename from docs/COPILOT_INSTRUCTIONS.md rename to docs/08-development-history/miscellaneous/copilot-instructions.md diff --git a/docs/DAK_MIGRATION_EXAMPLES.md b/docs/08-development-history/miscellaneous/dak-migration-examples.md similarity index 100% rename from docs/DAK_MIGRATION_EXAMPLES.md rename to docs/08-development-history/miscellaneous/dak-migration-examples.md diff --git a/FINAL_CHECKLIST.md b/docs/08-development-history/miscellaneous/final-checklist.md similarity index 100% rename from FINAL_CHECKLIST.md rename to docs/08-development-history/miscellaneous/final-checklist.md diff --git a/IMAGE_ASSET_VALIDITY_REPORT.md b/docs/08-development-history/miscellaneous/image-asset-validity-report.md similarity index 100% rename from IMAGE_ASSET_VALIDITY_REPORT.md rename to docs/08-development-history/miscellaneous/image-asset-validity-report.md diff --git a/IMPLEMENTATION_COMPLETE_SUMMARY.md b/docs/08-development-history/miscellaneous/implementation-complete-summary.md similarity index 100% rename from IMPLEMENTATION_COMPLETE_SUMMARY.md rename to docs/08-development-history/miscellaneous/implementation-complete-summary.md diff --git a/IMPLEMENTATION_COMPLETE.md b/docs/08-development-history/miscellaneous/implementation-complete.md similarity index 100% rename from IMPLEMENTATION_COMPLETE.md rename to docs/08-development-history/miscellaneous/implementation-complete.md diff --git a/IMPLEMENTATION_STATUS.md b/docs/08-development-history/miscellaneous/implementation-status.md similarity index 100% rename from IMPLEMENTATION_STATUS.md rename to docs/08-development-history/miscellaneous/implementation-status.md diff --git a/INTEGRATION_COMPLETE_SUMMARY.md b/docs/08-development-history/miscellaneous/integration-complete-summary.md similarity index 100% rename from INTEGRATION_COMPLETE_SUMMARY.md rename to docs/08-development-history/miscellaneous/integration-complete-summary.md diff --git a/LESS_SENSITIVE_FINGERPRINT_OPTIONS.md b/docs/08-development-history/miscellaneous/less-sensitive-fingerprint-options.md similarity index 100% rename from LESS_SENSITIVE_FINGERPRINT_OPTIONS.md rename to docs/08-development-history/miscellaneous/less-sensitive-fingerprint-options.md diff --git a/docs/pr-1060-requirements-checklist.md b/docs/08-development-history/miscellaneous/pr-1060-requirements-checklist.md similarity index 100% rename from docs/pr-1060-requirements-checklist.md rename to docs/08-development-history/miscellaneous/pr-1060-requirements-checklist.md diff --git a/docs/SERVICE_TABLE.md b/docs/08-development-history/miscellaneous/service-table.md similarity index 100% rename from docs/SERVICE_TABLE.md rename to docs/08-development-history/miscellaneous/service-table.md diff --git a/LAZY_ROUTING_ANALYSIS.md b/docs/08-development-history/technical-analysis/architecture-analysis/lazy-routing-analysis.md similarity index 100% rename from LAZY_ROUTING_ANALYSIS.md rename to docs/08-development-history/technical-analysis/architecture-analysis/lazy-routing-analysis.md diff --git a/COMPLIANCE_ANALYSIS.md b/docs/08-development-history/technical-analysis/compliance-analysis/compliance-analysis.md similarity index 100% rename from COMPLIANCE_ANALYSIS.md rename to docs/08-development-history/technical-analysis/compliance-analysis/compliance-analysis.md diff --git a/COMPLIANCE_CHECKER_DESIGN.md b/docs/08-development-history/technical-analysis/compliance-analysis/compliance-checker-design.md similarity index 100% rename from COMPLIANCE_CHECKER_DESIGN.md rename to docs/08-development-history/technical-analysis/compliance-analysis/compliance-checker-design.md diff --git a/HEURISTICS_ANALYSIS_REPORT.md b/docs/08-development-history/technical-analysis/compliance-analysis/heuristics-analysis-report.md similarity index 100% rename from HEURISTICS_ANALYSIS_REPORT.md rename to docs/08-development-history/technical-analysis/compliance-analysis/heuristics-analysis-report.md diff --git a/DAK_LOGICAL_MODEL_UPDATE_PLAN.md b/docs/08-development-history/technical-analysis/other-analysis/dak-logical-model-update-plan.md similarity index 100% rename from DAK_LOGICAL_MODEL_UPDATE_PLAN.md rename to docs/08-development-history/technical-analysis/other-analysis/dak-logical-model-update-plan.md diff --git a/GEOLOCATION_ANALYSIS.md b/docs/08-development-history/technical-analysis/other-analysis/geolocation-analysis.md similarity index 100% rename from GEOLOCATION_ANALYSIS.md rename to docs/08-development-history/technical-analysis/other-analysis/geolocation-analysis.md diff --git a/MERGE_CONFLICT_ANALYSIS.md b/docs/08-development-history/technical-analysis/other-analysis/merge-conflict-analysis.md similarity index 100% rename from MERGE_CONFLICT_ANALYSIS.md rename to docs/08-development-history/technical-analysis/other-analysis/merge-conflict-analysis.md diff --git a/MERGE_CONFLICT_RESOLUTION_PROPOSAL.md b/docs/08-development-history/technical-analysis/other-analysis/merge-conflict-resolution-proposal.md similarity index 100% rename from MERGE_CONFLICT_RESOLUTION_PROPOSAL.md rename to docs/08-development-history/technical-analysis/other-analysis/merge-conflict-resolution-proposal.md diff --git a/TYPESCRIPT_MIGRATION_PLAN.md b/docs/08-development-history/technical-analysis/other-analysis/typescript-migration-plan.md similarity index 100% rename from TYPESCRIPT_MIGRATION_PLAN.md rename to docs/08-development-history/technical-analysis/other-analysis/typescript-migration-plan.md diff --git a/docs/route-configuration.md b/docs/08-development-history/technical-analysis/routing-analysis/route-configuration.md similarity index 100% rename from docs/route-configuration.md rename to docs/08-development-history/technical-analysis/routing-analysis/route-configuration.md diff --git a/ROUTING_ANALYSIS.md b/docs/08-development-history/technical-analysis/routing-analysis/routing-analysis.md similarity index 100% rename from ROUTING_ANALYSIS.md rename to docs/08-development-history/technical-analysis/routing-analysis/routing-analysis.md diff --git a/ROUTING_CONSOLIDATION_PROPOSAL.md b/docs/08-development-history/technical-analysis/routing-analysis/routing-consolidation-proposal.md similarity index 100% rename from ROUTING_CONSOLIDATION_PROPOSAL.md rename to docs/08-development-history/technical-analysis/routing-analysis/routing-consolidation-proposal.md diff --git a/ROUTING_DOCUMENTATION_AUDIT.md b/docs/08-development-history/technical-analysis/routing-analysis/routing-documentation-audit.md similarity index 100% rename from ROUTING_DOCUMENTATION_AUDIT.md rename to docs/08-development-history/technical-analysis/routing-analysis/routing-documentation-audit.md diff --git a/docs/ROUTING_IMPLEMENTATION_GUIDE.md b/docs/08-development-history/technical-analysis/routing-analysis/routing-implementation-guide.md similarity index 100% rename from docs/ROUTING_IMPLEMENTATION_GUIDE.md rename to docs/08-development-history/technical-analysis/routing-analysis/routing-implementation-guide.md diff --git a/docs/ROUTING_LOGIC_WORKFLOW_DIAGRAM.md b/docs/08-development-history/technical-analysis/routing-analysis/routing-logic-workflow-diagram.md similarity index 100% rename from docs/ROUTING_LOGIC_WORKFLOW_DIAGRAM.md rename to docs/08-development-history/technical-analysis/routing-analysis/routing-logic-workflow-diagram.md diff --git a/docs/ROUTING_MIGRATION_PLAN.md b/docs/08-development-history/technical-analysis/routing-analysis/routing-migration-plan.md similarity index 100% rename from docs/ROUTING_MIGRATION_PLAN.md rename to docs/08-development-history/technical-analysis/routing-analysis/routing-migration-plan.md diff --git a/ROUTING_PLAN_FINALIZED.md b/docs/08-development-history/technical-analysis/routing-analysis/routing-plan-finalized.md similarity index 100% rename from ROUTING_PLAN_FINALIZED.md rename to docs/08-development-history/technical-analysis/routing-analysis/routing-plan-finalized.md diff --git a/docs/ROUTING_SOLUTION_PROPOSAL.md b/docs/08-development-history/technical-analysis/routing-analysis/routing-solution-proposal.md similarity index 100% rename from docs/ROUTING_SOLUTION_PROPOSAL.md rename to docs/08-development-history/technical-analysis/routing-analysis/routing-solution-proposal.md diff --git a/docs/ROUTING_SOLUTION_SUMMARY.md b/docs/08-development-history/technical-analysis/routing-analysis/routing-solution-summary.md similarity index 100% rename from docs/ROUTING_SOLUTION_SUMMARY.md rename to docs/08-development-history/technical-analysis/routing-analysis/routing-solution-summary.md diff --git a/LOCALSTORAGE_SECURITY_ANALYSIS.md b/docs/08-development-history/technical-analysis/security-analysis/localstorage-security-analysis.md similarity index 100% rename from LOCALSTORAGE_SECURITY_ANALYSIS.md rename to docs/08-development-history/technical-analysis/security-analysis/localstorage-security-analysis.md diff --git a/SESSIONSTORAGE_CROSS_TAB_SOLUTION.md b/docs/08-development-history/technical-analysis/security-analysis/sessionstorage-cross-tab-solution.md similarity index 100% rename from SESSIONSTORAGE_CROSS_TAB_SOLUTION.md rename to docs/08-development-history/technical-analysis/security-analysis/sessionstorage-cross-tab-solution.md diff --git a/debug-faq-test.md b/docs/08-development-history/test-documentation/debug-faq-test.md similarity index 100% rename from debug-faq-test.md rename to docs/08-development-history/test-documentation/debug-faq-test.md diff --git a/PHASE_7_TESTING_DOCUMENTATION.md b/docs/08-development-history/test-documentation/phase-7-testing.md similarity index 100% rename from PHASE_7_TESTING_DOCUMENTATION.md rename to docs/08-development-history/test-documentation/phase-7-testing.md diff --git a/test-improved-pr-feedback.md b/docs/08-development-history/test-documentation/pr-feedback-tests/test-improved-pr-feedback.md similarity index 100% rename from test-improved-pr-feedback.md rename to docs/08-development-history/test-documentation/pr-feedback-tests/test-improved-pr-feedback.md diff --git a/test-pr-feedback.md b/docs/08-development-history/test-documentation/pr-feedback-tests/test-pr-feedback.md similarity index 100% rename from test-pr-feedback.md rename to docs/08-development-history/test-documentation/pr-feedback-tests/test-pr-feedback.md diff --git a/test-session-feedback.md b/docs/08-development-history/test-documentation/pr-feedback-tests/test-session-feedback.md similarity index 100% rename from test-session-feedback.md rename to docs/08-development-history/test-documentation/pr-feedback-tests/test-session-feedback.md diff --git a/test-simplified-pr-comments.md b/docs/08-development-history/test-documentation/pr-feedback-tests/test-simplified-pr-comments.md similarity index 100% rename from test-simplified-pr-comments.md rename to docs/08-development-history/test-documentation/pr-feedback-tests/test-simplified-pr-comments.md diff --git a/TEST_FAILURE_NOTIFICATION_EXAMPLE.md b/docs/08-development-history/test-documentation/test-failure-notification-example.md similarity index 100% rename from TEST_FAILURE_NOTIFICATION_EXAMPLE.md rename to docs/08-development-history/test-documentation/test-failure-notification-example.md diff --git a/docs/404-implementation.md b/docs/08-development-history/ticket-fixes/404-routing/404-implementation.md similarity index 100% rename from docs/404-implementation.md rename to docs/08-development-history/ticket-fixes/404-routing/404-implementation.md diff --git a/docs/always-build-pages-fix-883.md b/docs/08-development-history/ticket-fixes/404-routing/always-build-pages-fix-883.md similarity index 100% rename from docs/always-build-pages-fix-883.md rename to docs/08-development-history/ticket-fixes/404-routing/always-build-pages-fix-883.md diff --git a/BADGE_ICON_PATH_FIX.md b/docs/08-development-history/ticket-fixes/404-routing/badge-icon-path-fix.md similarity index 100% rename from BADGE_ICON_PATH_FIX.md rename to docs/08-development-history/ticket-fixes/404-routing/badge-icon-path-fix.md diff --git a/docs/URL_ROUTING_FIX.md b/docs/08-development-history/ticket-fixes/404-routing/url-routing-fix.md similarity index 100% rename from docs/URL_ROUTING_FIX.md rename to docs/08-development-history/ticket-fixes/404-routing/url-routing-fix.md diff --git a/PAGE_RELOAD_TOKEN_LOSS_ANALYSIS.md b/docs/08-development-history/ticket-fixes/authentication/page-reload-token-loss.md similarity index 100% rename from PAGE_RELOAD_TOKEN_LOSS_ANALYSIS.md rename to docs/08-development-history/ticket-fixes/authentication/page-reload-token-loss.md diff --git a/PAT_TOKEN_DEBUGGING_GUIDE.md b/docs/08-development-history/ticket-fixes/authentication/pat-token-debugging.md similarity index 100% rename from PAT_TOKEN_DEBUGGING_GUIDE.md rename to docs/08-development-history/ticket-fixes/authentication/pat-token-debugging.md diff --git a/PAT_TOKEN_FLOW_ANALYSIS.md b/docs/08-development-history/ticket-fixes/authentication/pat-token-flow-analysis.md similarity index 100% rename from PAT_TOKEN_FLOW_ANALYSIS.md rename to docs/08-development-history/ticket-fixes/authentication/pat-token-flow-analysis.md diff --git a/PAT_TOKEN_INVESTIGATION_README.md b/docs/08-development-history/ticket-fixes/authentication/pat-token-investigation.md similarity index 100% rename from PAT_TOKEN_INVESTIGATION_README.md rename to docs/08-development-history/ticket-fixes/authentication/pat-token-investigation.md diff --git a/PAT_TOKEN_LOSS_INVESTIGATION.md b/docs/08-development-history/ticket-fixes/authentication/pat-token-loss-investigation.md similarity index 100% rename from PAT_TOKEN_LOSS_INVESTIGATION.md rename to docs/08-development-history/ticket-fixes/authentication/pat-token-loss-investigation.md diff --git a/BRANCH_DEPLOYMENT_FIX.md b/docs/08-development-history/ticket-fixes/deployment/branch-deployment-fix.md similarity index 100% rename from BRANCH_DEPLOYMENT_FIX.md rename to docs/08-development-history/ticket-fixes/deployment/branch-deployment-fix.md diff --git a/DEPLOY_BRANCH_ESLINT_FIX.md b/docs/08-development-history/ticket-fixes/deployment/deploy-branch-eslint-fix.md similarity index 100% rename from DEPLOY_BRANCH_ESLINT_FIX.md rename to docs/08-development-history/ticket-fixes/deployment/deploy-branch-eslint-fix.md diff --git a/DEPLOY_BRANCH_FIX.md b/docs/08-development-history/ticket-fixes/deployment/deploy-branch-fix.md similarity index 100% rename from DEPLOY_BRANCH_FIX.md rename to docs/08-development-history/ticket-fixes/deployment/deploy-branch-fix.md diff --git a/docs/deployment-fix-625.md b/docs/08-development-history/ticket-fixes/deployment/deployment-fix-625.md similarity index 100% rename from docs/deployment-fix-625.md rename to docs/08-development-history/ticket-fixes/deployment/deployment-fix-625.md diff --git a/docs/deployment-fix-691.md b/docs/08-development-history/ticket-fixes/deployment/deployment-fix-691.md similarity index 100% rename from docs/deployment-fix-691.md rename to docs/08-development-history/ticket-fixes/deployment/deployment-fix-691.md diff --git a/PREVIEW_BUILDS_FIX.md b/docs/08-development-history/ticket-fixes/deployment/preview-builds-fix.md similarity index 100% rename from PREVIEW_BUILDS_FIX.md rename to docs/08-development-history/ticket-fixes/deployment/preview-builds-fix.md diff --git a/ESLINT_FIX_SUMMARY.md b/docs/08-development-history/ticket-fixes/other-fixes/eslint-fix-summary.md similarity index 100% rename from ESLINT_FIX_SUMMARY.md rename to docs/08-development-history/ticket-fixes/other-fixes/eslint-fix-summary.md diff --git a/ROUTING_FIX_PLAN.md b/docs/08-development-history/ticket-fixes/other-fixes/routing-fix-plan.md similarity index 100% rename from ROUTING_FIX_PLAN.md rename to docs/08-development-history/ticket-fixes/other-fixes/routing-fix-plan.md diff --git a/WHO_REPO_SCANNING_FIX_SUMMARY.md b/docs/08-development-history/ticket-fixes/other-fixes/who-repo-scanning-fix.md similarity index 100% rename from WHO_REPO_SCANNING_FIX_SUMMARY.md rename to docs/08-development-history/ticket-fixes/other-fixes/who-repo-scanning-fix.md diff --git a/BPMN_DISPLAY_FIX.md b/docs/08-development-history/ticket-fixes/ui-fixes/bpmn-display-fix.md similarity index 100% rename from BPMN_DISPLAY_FIX.md rename to docs/08-development-history/ticket-fixes/ui-fixes/bpmn-display-fix.md diff --git a/DARK_MODE_IMAGE_AUDIT.md b/docs/08-development-history/ticket-fixes/ui-fixes/dark-mode-image-audit.md similarity index 100% rename from DARK_MODE_IMAGE_AUDIT.md rename to docs/08-development-history/ticket-fixes/ui-fixes/dark-mode-image-audit.md diff --git a/PR_TITLE_PRESERVATION_FIX.md b/docs/08-development-history/ticket-fixes/workflow-fixes/pr-title-preservation-fix.md similarity index 100% rename from PR_TITLE_PRESERVATION_FIX.md rename to docs/08-development-history/ticket-fixes/workflow-fixes/pr-title-preservation-fix.md diff --git a/docs/workflow-comment-fix.md b/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-fix.md similarity index 100% rename from docs/workflow-comment-fix.md rename to docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-fix.md diff --git a/WORKFLOW_COMMENT_MARKER_FIX_SUMMARY.md b/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-marker-fix.md similarity index 100% rename from WORKFLOW_COMMENT_MARKER_FIX_SUMMARY.md rename to docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-marker-fix.md diff --git a/docs/workflow-concurrency-fix-841.md b/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-concurrency-fix-841.md similarity index 100% rename from docs/workflow-concurrency-fix-841.md rename to docs/08-development-history/ticket-fixes/workflow-fixes/workflow-concurrency-fix-841.md diff --git a/test-pr-feedback-improvements.md b/test-pr-feedback-improvements.md deleted file mode 100644 index eb7e654887..0000000000 --- a/test-pr-feedback-improvements.md +++ /dev/null @@ -1,74 +0,0 @@ -# PR Feedback Improvements Test - -This document outlines the improvements made to the PR feedback system and how to test them. - -## Improvements Made - -### 1. Better Button-Style Formatting -- Replaced plain text links with styled badge buttons using shields.io -- Added visual hierarchy with color-coded buttons (green for success, orange for actions, red for errors) -- Created table layouts for better visual organization - -### 2. Direct Workflow Dispatch URLs -- Added pre-filled branch parameters to workflow dispatch URLs -- Users no longer need to manually type branch names -- URLs now include `?branch=` parameter for automatic population - -### 3. Enhanced User Experience -- Clear call-to-action buttons with descriptive labels -- Consistent formatting across all feedback messages -- Better visual separation between different types of actions - -### 4. Improved Messaging -- More actionable instructions -- Clearer progress indicators -- Better error handling guidance - -## Test Scenarios - -### Scenario 1: New Commit Requiring Approval -1. Create a new branch with changes -2. Push a commit to the branch -3. Verify PR comment is created with: - - ✅ APPROVE & RUN button (green) - - 🔄 REDEPLOY BRANCH button (blue) - - Clear instructions for each action - -### Scenario 2: Successful Deployment -1. Approve and run deployment -2. Verify PR comment is updated with: - - 🌐 BRANCH PREVIEW button (green) - - 🏠 MAIN APP button (blue) - - 🚀 REDEPLOY BRANCH button (orange) - - 📄 BUILD LOGS button (gray) - -### Scenario 3: Failed Deployment -1. Push a commit with build errors -2. Verify PR comment shows: - - 📄 CHECK LOGS button (red) - - 🔄 RETRY BUILD button (orange) - - Helpful troubleshooting information - -### Scenario 4: PR Approval -1. Approve a PR -2. Verify approval comment includes: - - 🚀 DEPLOY BRANCH button (green) - - Pre-filled workflow dispatch URL - - Clear deployment instructions - -## Button Types and Colors - -- **Green (4CAF50)**: Success actions (approve, deploy, open preview) -- **Blue (2196F3)**: Navigation actions (main app, workflow dispatch) -- **Orange (FF9800)**: Retry/redeploy actions -- **Red (DC3545)**: Error investigation actions -- **Gray (6C757D)**: Informational actions (logs, details) - -## URL Parameters - -All workflow dispatch URLs now include pre-filled parameters: -``` -https://github.com/owner/repo/actions/workflows/branch-deployment.yml?branch=branchname -``` - -This eliminates the need for users to manually enter branch names. \ No newline at end of file From d95ec1f34696a48a0582173b28a1606c9482eed7 Mon Sep 17 00:00:00 2001 From: ritikarawlani <38657562+ritikarawlani@users.noreply.github.com> Date: Mon, 15 Dec 2025 14:37:53 +0530 Subject: [PATCH 2/2] update --- n.bat | 153 ++++++++++++++++++ .../docs}/01-getting-started/README.md | 0 .../01-getting-started/troubleshooting.md | 0 .../docs}/02-user-guides/README.md | 0 .../02-user-guides/build-logging-reference.md | 0 .../docs}/02-user-guides/build-logging.md | 0 .../docs}/02-user-guides/dak-usage-guide.md | 0 .../02-user-guides/image-optimization.md | 0 .../docs}/02-user-guides/saml-workflow.md | 0 .../02-user-guides/workflow-automation.md | 0 .../02-user-guides/workflow-interaction.md | 0 .../docs}/03-architecture/README.md | 0 .../dak-publication-architecture.md | 0 .../fixed-height-layout.md} | 0 .../l2-l3-architecture.md | 0 .../mcp-services/faq-documentation.md | 0 .../mcp-services/faq-service.md | 0 .../page-framework-guide.md} | 0 .../docs}/03-architecture/page-framework.md | 0 .../{ => 03-architecture}/page-inventory.md | 0 .../solution-architecture.md | 0 .../ui-styling-requirements.md} | 0 .../docs}/04-development/README.md | 0 .../docs}/04-development/accessibility.md | 0 .../04-development/compliance-framework.md | 0 .../css-variables-reference.md} | 0 .../framework-developer-guide.md | 0 .../docs}/04-development/framework-hooks.md | 0 .../docs/{ => 04-development}/qa-testing.md | 0 .../docs/{ => 04-development}/requirements.md | 0 .../runtime-validation-integration.md | 0 .../runtime-validation.md | 0 .../schema-generation.md} | 0 .../typescript-documentation-index.md | 0 .../04-development/typescript-migration.md | 0 {docs => public/docs}/05-deployment/README.md | 0 .../branch-pr-workflow.md} | 0 .../build-process-integration.md | 0 .../compliance-framework.md | 0 .../docs}/05-deployment/github-pages.md | 0 .../multi-branch-requirements.md} | 0 .../docs}/05-deployment/overview.md | 0 .../docs/{ => 05-deployment}/project-plan.md | 0 .../docs}/05-deployment/workflows-analysis.md | 0 {docs => public/docs}/06-security/README.md | 0 .../docs}/06-security/additional-tools.md | 0 .../docs}/06-security/codeql-analysis.md | 0 .../06-security/framework-overlap-analysis.md | 0 .../06-security/security-check-examples.md | 0 .../security-check-implementation.md | 0 .../06-security/security-check-next-steps.md | 0 .../docs}/06-security/security-checks.md | 0 .../{ => 06-security}/security-headers.md | 0 .../who-cors-workaround.md} | 0 {docs => public/docs}/07-features/README.md | 0 .../{ => 07-features}/asset-management.md | 0 .../docs/{ => 07-features}/bookmark-system.md | 0 .../{ => 07-features}/bpmn-integration.md | 0 .../custom-formats.md} | 0 .../docs/{ => 07-features}/dak-components.md | 0 .../decision-table-editor.md | 0 .../docs}/07-features/future-enhancements.md | 0 .../persona-viewer-enhancements.md | 0 .../profile-subscription.md} | 0 .../{ => 07-features}/tutorial-framework.md | 0 .../docs}/08-development-history/README.md | 0 .../comment-simplification.md | 0 .../deployment-optimization.md | 0 .../pr-workflow-failure-notifier.md | 0 .../proposed-workflow-changes.md | 0 .../css-phases/css-review-workplan.md | 0 .../css-phases/phase2-completion.md | 0 .../css-phases/phase3-continuation.md | 0 .../css-phases/phase3-final.md | 0 .../css-phases/phase3-progress.md | 0 .../build-logging-implementation.md | 0 .../compliance-implementation.md | 0 .../dak-implementation-status.md | 0 .../dak-publication-api.md} | 0 .../dak-publication.md} | 0 .../pr-1092-implementation.md | 0 .../remember-me-implementation.md | 0 .../routing-implementation-status.md | 0 .../service-table-implementation.md | 0 .../tinymce-migration-implementation.md | 0 .../tinymce-migration-plan.md | 0 .../wysiwyg-editor-comparison.md | 0 .../wysiwyg-implementation-guide.md | 0 .../mcp-migration/mcp-improvements-summary.md | 0 .../mcp-migration-implementation.md | 0 .../mcp-upstream-improvements.md | 0 .../service-refactoring-analysis-revised.md | 0 .../service-refactoring-analysis.md | 0 .../service-refactoring-status.md | 0 .../sushi-refactor-summary.md | 0 .../dak-typescript-refactoring.md | 0 .../faq-typescript-integration.md | 0 .../phase-6-editor-integration.md | 0 .../phase-7-migration-status.md | 0 .../miscellaneous/approval-summary.md | 0 .../miscellaneous/build-logging-section.md | 0 .../miscellaneous/copilot-instructions.md | 0 .../miscellaneous/dak-migration-examples.md | 0 .../miscellaneous/final-checklist.md | 0 .../image-asset-validity-report.md | 0 .../implementation-complete-summary.md | 0 .../miscellaneous/implementation-complete.md | 0 .../miscellaneous/implementation-status.md | 0 .../integration-complete-summary.md | 0 .../less-sensitive-fingerprint-options.md | 0 .../pr-1060-requirements-checklist.md | 0 .../miscellaneous/service-table.md | 0 .../lazy-routing-analysis.md | 0 .../compliance-analysis.md | 0 .../compliance-checker-design.md | 0 .../heuristics-analysis-report.md | 0 .../dak-logical-model-update-plan.md | 0 .../dak-publication-options.md} | 0 .../other-analysis/dak-publication-spec.md} | 0 .../dak-publication-wysiwyg.md} | 0 .../other-analysis/geolocation-analysis.md | 0 .../other-analysis/merge-conflict-analysis.md | 0 .../merge-conflict-resolution-proposal.md | 0 .../typescript-migration-plan.md | 0 .../routing-analysis/route-configuration.md | 0 .../routing-analysis/routing-analysis.md | 0 .../routing-consolidation-proposal.md | 0 .../routing-documentation-audit.md | 0 .../routing-implementation-guide.md | 0 .../routing-logic-workflow-diagram.md | 0 .../routing-migration-plan.md | 0 .../routing-plan-finalized.md | 0 .../routing-solution-proposal.md | 0 .../routing-solution-summary.md | 0 .../localstorage-security-analysis.md | 0 .../sessionstorage-cross-tab-solution.md | 0 .../test-documentation/debug-faq-test.md | 0 .../test-documentation/phase-7-testing.md | 0 .../test-improved-pr-feedback.md | 0 .../pr-feedback-tests/test-pr-feedback.md | 0 .../test-session-feedback.md | 0 .../test-simplified-pr-comments.md | 0 .../test-failure-notification-example.md | 0 .../404-routing/404-implementation.md | 0 .../404-routing/always-build-pages-fix-883.md | 0 .../404-routing/badge-icon-path-fix.md | 0 .../404-routing/url-routing-fix.md | 0 .../authentication/page-reload-token-loss.md | 0 .../authentication/pat-token-debugging.md | 0 .../authentication/pat-token-flow-analysis.md | 0 .../authentication/pat-token-investigation.md | 0 .../pat-token-loss-investigation.md | 0 .../deployment/branch-deployment-fix.md | 0 .../deployment/deploy-branch-eslint-fix.md | 0 .../deployment/deploy-branch-fix.md | 0 .../deployment/deployment-fix-625.md | 0 .../deployment/deployment-fix-691.md | 0 .../deployment/preview-builds-fix.md | 0 .../other-fixes/eslint-fix-summary.md | 0 .../other-fixes/routing-fix-plan.md | 0 .../other-fixes/who-repo-scanning-fix.md | 0 .../ticket-fixes/ui-fixes/bpmn-display-fix.md | 0 .../ui-fixes/dark-mode-image-audit.md | 0 .../pr-title-preservation-fix.md | 0 .../workflow-fixes/workflow-comment-fix.md | 0 .../workflow-comment-marker-fix.md | 0 .../workflow-concurrency-fix-841.md | 0 .../dak/faq/component-questions-draft.md | 0 .../docs}/dak/faq/implementation-summary.md | 0 .../docs}/dak/faq/parameters/registry.yaml | 0 170 files changed, 153 insertions(+) create mode 100644 n.bat rename {docs => public/docs}/01-getting-started/README.md (100%) rename {docs => public/docs}/01-getting-started/troubleshooting.md (100%) rename {docs => public/docs}/02-user-guides/README.md (100%) rename {docs => public/docs}/02-user-guides/build-logging-reference.md (100%) rename {docs => public/docs}/02-user-guides/build-logging.md (100%) rename {docs => public/docs}/02-user-guides/dak-usage-guide.md (100%) rename {docs => public/docs}/02-user-guides/image-optimization.md (100%) rename {docs => public/docs}/02-user-guides/saml-workflow.md (100%) rename {docs => public/docs}/02-user-guides/workflow-automation.md (100%) rename {docs => public/docs}/02-user-guides/workflow-interaction.md (100%) rename {docs => public/docs}/03-architecture/README.md (100%) rename {docs => public/docs}/03-architecture/dak-publication-architecture.md (100%) rename public/docs/{fixed-height-layout-requirements.md => 03-architecture/fixed-height-layout.md} (100%) rename public/docs/{ => 03-architecture}/l2-l3-architecture.md (100%) rename {docs => public/docs}/03-architecture/mcp-services/faq-documentation.md (100%) rename {docs => public/docs}/03-architecture/mcp-services/faq-service.md (100%) rename public/docs/{page-framework.md => 03-architecture/page-framework-guide.md} (100%) rename {docs => public/docs}/03-architecture/page-framework.md (100%) rename public/docs/{ => 03-architecture}/page-inventory.md (100%) rename public/docs/{ => 03-architecture}/solution-architecture.md (100%) rename public/docs/{UI_STYLING_REQUIREMENTS.md => 03-architecture/ui-styling-requirements.md} (100%) rename {docs => public/docs}/04-development/README.md (100%) rename {docs => public/docs}/04-development/accessibility.md (100%) rename {docs => public/docs}/04-development/compliance-framework.md (100%) rename public/docs/{CSS_VARIABLES_REFERENCE.md => 04-development/css-variables-reference.md} (100%) rename public/docs/{ => 04-development}/framework-developer-guide.md (100%) rename {docs => public/docs}/04-development/framework-hooks.md (100%) rename public/docs/{ => 04-development}/qa-testing.md (100%) rename public/docs/{ => 04-development}/requirements.md (100%) rename public/docs/{ => 04-development}/runtime-validation-integration.md (100%) rename public/docs/{ => 04-development}/runtime-validation.md (100%) rename public/docs/{schema-generation-configuration.md => 04-development/schema-generation.md} (100%) rename public/docs/{ => 04-development}/typescript-documentation-index.md (100%) rename {docs => public/docs}/04-development/typescript-migration.md (100%) rename {docs => public/docs}/05-deployment/README.md (100%) rename public/docs/{branch-specific-pr-workflow.md => 05-deployment/branch-pr-workflow.md} (100%) rename public/docs/{ => 05-deployment}/build-process-integration.md (100%) rename public/docs/{ => 05-deployment}/compliance-framework.md (100%) rename {docs => public/docs}/05-deployment/github-pages.md (100%) rename public/docs/{multi-branch-deployment-requirements.md => 05-deployment/multi-branch-requirements.md} (100%) rename {docs => public/docs}/05-deployment/overview.md (100%) rename public/docs/{ => 05-deployment}/project-plan.md (100%) rename {docs => public/docs}/05-deployment/workflows-analysis.md (100%) rename {docs => public/docs}/06-security/README.md (100%) rename {docs => public/docs}/06-security/additional-tools.md (100%) rename {docs => public/docs}/06-security/codeql-analysis.md (100%) rename {docs => public/docs}/06-security/framework-overlap-analysis.md (100%) rename {docs => public/docs}/06-security/security-check-examples.md (100%) rename {docs => public/docs}/06-security/security-check-implementation.md (100%) rename {docs => public/docs}/06-security/security-check-next-steps.md (100%) rename {docs => public/docs}/06-security/security-checks.md (100%) rename public/docs/{ => 06-security}/security-headers.md (100%) rename public/docs/{WHO_CORS_WORKAROUND.md => 06-security/who-cors-workaround.md} (100%) rename {docs => public/docs}/07-features/README.md (100%) rename public/docs/{ => 07-features}/asset-management.md (100%) rename public/docs/{ => 07-features}/bookmark-system.md (100%) rename public/docs/{ => 07-features}/bpmn-integration.md (100%) rename public/docs/{custom-formats-documentation.md => 07-features/custom-formats.md} (100%) rename public/docs/{ => 07-features}/dak-components.md (100%) rename public/docs/{ => 07-features}/decision-table-editor.md (100%) rename {docs => public/docs}/07-features/future-enhancements.md (100%) rename {docs => public/docs}/07-features/persona-viewer-enhancements.md (100%) rename public/docs/{profile-subscription-system.md => 07-features/profile-subscription.md} (100%) rename public/docs/{ => 07-features}/tutorial-framework.md (100%) rename {docs => public/docs}/08-development-history/README.md (100%) rename {docs => public/docs}/08-development-history/deployment-optimization/comment-simplification.md (100%) rename {docs => public/docs}/08-development-history/deployment-optimization/deployment-optimization.md (100%) rename {docs => public/docs}/08-development-history/deployment-optimization/pr-workflow-failure-notifier.md (100%) rename {docs => public/docs}/08-development-history/deployment-optimization/proposed-workflow-changes.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/css-phases/css-review-workplan.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/css-phases/phase2-completion.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/css-phases/phase3-continuation.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/css-phases/phase3-final.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/css-phases/phase3-progress.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/feature-implementations/build-logging-implementation.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/feature-implementations/compliance-implementation.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/feature-implementations/dak-implementation-status.md (100%) rename public/docs/{dak-publication-api-implementation-summary.md => 08-development-history/implementation-summaries/feature-implementations/dak-publication-api.md} (100%) rename public/docs/{dak-publication-implementation-summary.md => 08-development-history/implementation-summaries/feature-implementations/dak-publication.md} (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/feature-implementations/pr-1092-implementation.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/feature-implementations/remember-me-implementation.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/feature-implementations/routing-implementation-status.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/feature-implementations/service-table-implementation.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-implementation.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-plan.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-editor-comparison.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-implementation-guide.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-improvements-summary.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-migration-implementation.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-upstream-improvements.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis-revised.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-status.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/service-refactoring/sushi-refactor-summary.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/dak-typescript-refactoring.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/faq-typescript-integration.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-6-editor-integration.md (100%) rename {docs => public/docs}/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-7-migration-status.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/approval-summary.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/build-logging-section.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/copilot-instructions.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/dak-migration-examples.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/final-checklist.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/image-asset-validity-report.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/implementation-complete-summary.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/implementation-complete.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/implementation-status.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/integration-complete-summary.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/less-sensitive-fingerprint-options.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/pr-1060-requirements-checklist.md (100%) rename {docs => public/docs}/08-development-history/miscellaneous/service-table.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/architecture-analysis/lazy-routing-analysis.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/compliance-analysis/compliance-analysis.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/compliance-analysis/compliance-checker-design.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/compliance-analysis/heuristics-analysis-report.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/other-analysis/dak-logical-model-update-plan.md (100%) rename public/docs/{dak-publication-options-analysis.md => 08-development-history/technical-analysis/other-analysis/dak-publication-options.md} (100%) rename public/docs/{dak-publication-technical-spec.md => 08-development-history/technical-analysis/other-analysis/dak-publication-spec.md} (100%) rename public/docs/{dak-publication-wysiwyg-analysis.md => 08-development-history/technical-analysis/other-analysis/dak-publication-wysiwyg.md} (100%) rename {docs => public/docs}/08-development-history/technical-analysis/other-analysis/geolocation-analysis.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/other-analysis/merge-conflict-analysis.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/other-analysis/merge-conflict-resolution-proposal.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/other-analysis/typescript-migration-plan.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/route-configuration.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/routing-analysis.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/routing-consolidation-proposal.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/routing-documentation-audit.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/routing-implementation-guide.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/routing-logic-workflow-diagram.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/routing-migration-plan.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/routing-plan-finalized.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/routing-solution-proposal.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/routing-analysis/routing-solution-summary.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/security-analysis/localstorage-security-analysis.md (100%) rename {docs => public/docs}/08-development-history/technical-analysis/security-analysis/sessionstorage-cross-tab-solution.md (100%) rename {docs => public/docs}/08-development-history/test-documentation/debug-faq-test.md (100%) rename {docs => public/docs}/08-development-history/test-documentation/phase-7-testing.md (100%) rename {docs => public/docs}/08-development-history/test-documentation/pr-feedback-tests/test-improved-pr-feedback.md (100%) rename {docs => public/docs}/08-development-history/test-documentation/pr-feedback-tests/test-pr-feedback.md (100%) rename {docs => public/docs}/08-development-history/test-documentation/pr-feedback-tests/test-session-feedback.md (100%) rename {docs => public/docs}/08-development-history/test-documentation/pr-feedback-tests/test-simplified-pr-comments.md (100%) rename {docs => public/docs}/08-development-history/test-documentation/test-failure-notification-example.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/404-routing/404-implementation.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/404-routing/always-build-pages-fix-883.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/404-routing/badge-icon-path-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/404-routing/url-routing-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/authentication/page-reload-token-loss.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/authentication/pat-token-debugging.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/authentication/pat-token-flow-analysis.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/authentication/pat-token-investigation.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/authentication/pat-token-loss-investigation.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/deployment/branch-deployment-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/deployment/deploy-branch-eslint-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/deployment/deploy-branch-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/deployment/deployment-fix-625.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/deployment/deployment-fix-691.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/deployment/preview-builds-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/other-fixes/eslint-fix-summary.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/other-fixes/routing-fix-plan.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/other-fixes/who-repo-scanning-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/ui-fixes/bpmn-display-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/ui-fixes/dark-mode-image-audit.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/workflow-fixes/pr-title-preservation-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-marker-fix.md (100%) rename {docs => public/docs}/08-development-history/ticket-fixes/workflow-fixes/workflow-concurrency-fix-841.md (100%) rename {docs => public/docs}/dak/faq/component-questions-draft.md (100%) rename {docs => public/docs}/dak/faq/implementation-summary.md (100%) rename {docs => public/docs}/dak/faq/parameters/registry.yaml (100%) diff --git a/n.bat b/n.bat new file mode 100644 index 0000000000..da114b86d4 --- /dev/null +++ b/n.bat @@ -0,0 +1,153 @@ +@echo off +REM Public/Docs Consolidation - Move developer docs to docs/ + +setlocal EnableDelayedExpansion + +set BASE=%~dp0 +set PUBLIC_DOCS=%BASE%public\docs +set DOCS=%BASE%docs + +echo ================================================================================ +echo SGEX WORKBENCH - PUBLIC/DOCS CONSOLIDATION +echo ================================================================================ +echo. +echo This script will move developer-facing documentation from public/docs/ to docs/ +echo. +echo Files to move: 28 +echo - Architecture docs: 6 files +echo - Development docs: 8 files +echo - Deployment docs: 3 files +echo - Security docs: 2 files +echo - Feature docs: 7 files +echo - Historical docs: 5 files +echo. +echo Files will STAY in public/docs/: 18 (user-facing docs, MCP, workflows, schemas) +echo. +echo Press any key to continue or Ctrl+C to cancel... +pause >nul + +echo. +echo ================================================================================ +echo PHASE 1: Moving Architecture Documentation +echo ================================================================================ +echo. + +set MOVED=0 +set SKIPPED=0 + +REM Helper macro for moving files +set "MOVEFILE=call :MoveFile" + +REM Architecture Documentation +echo [1/6] Architecture Documentation... +%MOVEFILE% "%PUBLIC_DOCS%\framework-developer-guide.md" "%DOCS%\04-development\framework-developer-guide.md" +%MOVEFILE% "%PUBLIC_DOCS%\fixed-height-layout-requirements.md" "%DOCS%\03-architecture\fixed-height-layout.md" +%MOVEFILE% "%PUBLIC_DOCS%\page-inventory.md" "%DOCS%\03-architecture\page-inventory.md" +%MOVEFILE% "%PUBLIC_DOCS%\UI_STYLING_REQUIREMENTS.md" "%DOCS%\03-architecture\ui-styling-requirements.md" +%MOVEFILE% "%PUBLIC_DOCS%\CSS_VARIABLES_REFERENCE.md" "%DOCS%\04-development\css-variables-reference.md" + +echo. +echo ================================================================================ +echo PHASE 2: Moving Feature Documentation +echo ================================================================================ +echo. + +echo [2/6] Feature Documentation... +%MOVEFILE% "%PUBLIC_DOCS%\asset-management.md" "%DOCS%\07-features\asset-management.md" +%MOVEFILE% "%PUBLIC_DOCS%\bookmark-system.md" "%DOCS%\07-features\bookmark-system.md" +%MOVEFILE% "%PUBLIC_DOCS%\bpmn-integration.md" "%DOCS%\07-features\bpmn-integration.md" +%MOVEFILE% "%PUBLIC_DOCS%\decision-table-editor.md" "%DOCS%\07-features\decision-table-editor.md" +%MOVEFILE% "%PUBLIC_DOCS%\profile-subscription-system.md" "%DOCS%\07-features\profile-subscription.md" +%MOVEFILE% "%PUBLIC_DOCS%\tutorial-framework.md" "%DOCS%\07-features\tutorial-framework.md" +%MOVEFILE% "%PUBLIC_DOCS%\custom-formats-documentation.md" "%DOCS%\07-features\custom-formats.md" + +echo. +echo ================================================================================ +echo PHASE 3: Moving Development Documentation +echo ================================================================================ +echo. + +echo [3/6] Development Documentation... +%MOVEFILE% "%PUBLIC_DOCS%\runtime-validation.md" "%DOCS%\04-development\runtime-validation.md" +%MOVEFILE% "%PUBLIC_DOCS%\runtime-validation-integration.md" "%DOCS%\04-development\runtime-validation-integration.md" +%MOVEFILE% "%PUBLIC_DOCS%\typescript-documentation-index.md" "%DOCS%\04-development\typescript-documentation-index.md" +%MOVEFILE% "%PUBLIC_DOCS%\schema-generation-configuration.md" "%DOCS%\04-development\schema-generation.md" + +echo. +echo ================================================================================ +echo PHASE 4: Moving Deployment Documentation +echo ================================================================================ +echo. + +echo [4/6] Deployment Documentation... +%MOVEFILE% "%PUBLIC_DOCS%\multi-branch-deployment-requirements.md" "%DOCS%\05-deployment\multi-branch-requirements.md" +%MOVEFILE% "%PUBLIC_DOCS%\branch-specific-pr-workflow.md" "%DOCS%\05-deployment\branch-pr-workflow.md" +%MOVEFILE% "%PUBLIC_DOCS%\build-process-integration.md" "%DOCS%\05-deployment\build-process-integration.md" + +echo. +echo ================================================================================ +echo PHASE 5: Moving Security Documentation +echo ================================================================================ +echo. + +echo [5/6] Security Documentation... +%MOVEFILE% "%PUBLIC_DOCS%\security-headers.md" "%DOCS%\06-security\security-headers.md" +%MOVEFILE% "%PUBLIC_DOCS%\WHO_CORS_WORKAROUND.md" "%DOCS%\06-security\who-cors-workaround.md" + +echo. +echo ================================================================================ +echo PHASE 6: Moving Historical Documentation +echo ================================================================================ +echo. + +echo [6/6] Historical Documentation... +%MOVEFILE% "%PUBLIC_DOCS%\dak-publication-api-implementation-summary.md" "%DOCS%\08-development-history\implementation-summaries\feature-implementations\dak-publication-api.md" +%MOVEFILE% "%PUBLIC_DOCS%\dak-publication-implementation-summary.md" "%DOCS%\08-development-history\implementation-summaries\feature-implementations\dak-publication.md" +%MOVEFILE% "%PUBLIC_DOCS%\dak-publication-options-analysis.md" "%DOCS%\08-development-history\technical-analysis\other-analysis\dak-publication-options.md" +%MOVEFILE% "%PUBLIC_DOCS%\dak-publication-technical-spec.md" "%DOCS%\08-development-history\technical-analysis\other-analysis\dak-publication-spec.md" +%MOVEFILE% "%PUBLIC_DOCS%\dak-publication-wysiwyg-analysis.md" "%DOCS%\08-development-history\technical-analysis\other-analysis\dak-publication-wysiwyg.md" + +echo. +echo ================================================================================ +echo CONSOLIDATION COMPLETE! +echo ================================================================================ +echo. +echo Files moved successfully: %MOVED% +echo Files skipped (not found): %SKIPPED% +echo. +echo Remaining in public/docs/: +echo ✓ Core documentation (project-plan, requirements, solution-architecture, etc.) +echo ✓ MCP services documentation (mcp/) +echo ✓ Workflow diagrams (workflows/) +echo ✓ Runtime schemas (schemas/) +echo ✓ Images (*.png) +echo ✓ Static HTML (dak-faq-documentation.html) +echo. +echo Next steps: +echo 1. Update public/docs/README.md to reflect new structure +echo 2. Update links in moved documents +echo 3. Update docs/INDEX.md with new files +echo 4. Test all documentation links +echo 5. Commit changes to version control: +echo git add -A +echo git commit -m "docs: consolidate developer docs from public/docs to docs/" +echo git push +echo. +echo Press any key to exit... +pause >nul +goto :EOF + +:MoveFile +if exist "%~1" ( + move "%~1" "%~2" >nul 2>&1 + if errorlevel 1 ( + echo ✗ FAILED: %~nx1 + ) else ( + echo ✓ %~nx1 → %~nx2 + set /a MOVED+=1 + ) +) else ( + echo ⊘ SKIPPED: %~nx1 ^(not found^) + set /a SKIPPED+=1 +) +goto :EOF \ No newline at end of file diff --git a/docs/01-getting-started/README.md b/public/docs/01-getting-started/README.md similarity index 100% rename from docs/01-getting-started/README.md rename to public/docs/01-getting-started/README.md diff --git a/docs/01-getting-started/troubleshooting.md b/public/docs/01-getting-started/troubleshooting.md similarity index 100% rename from docs/01-getting-started/troubleshooting.md rename to public/docs/01-getting-started/troubleshooting.md diff --git a/docs/02-user-guides/README.md b/public/docs/02-user-guides/README.md similarity index 100% rename from docs/02-user-guides/README.md rename to public/docs/02-user-guides/README.md diff --git a/docs/02-user-guides/build-logging-reference.md b/public/docs/02-user-guides/build-logging-reference.md similarity index 100% rename from docs/02-user-guides/build-logging-reference.md rename to public/docs/02-user-guides/build-logging-reference.md diff --git a/docs/02-user-guides/build-logging.md b/public/docs/02-user-guides/build-logging.md similarity index 100% rename from docs/02-user-guides/build-logging.md rename to public/docs/02-user-guides/build-logging.md diff --git a/docs/02-user-guides/dak-usage-guide.md b/public/docs/02-user-guides/dak-usage-guide.md similarity index 100% rename from docs/02-user-guides/dak-usage-guide.md rename to public/docs/02-user-guides/dak-usage-guide.md diff --git a/docs/02-user-guides/image-optimization.md b/public/docs/02-user-guides/image-optimization.md similarity index 100% rename from docs/02-user-guides/image-optimization.md rename to public/docs/02-user-guides/image-optimization.md diff --git a/docs/02-user-guides/saml-workflow.md b/public/docs/02-user-guides/saml-workflow.md similarity index 100% rename from docs/02-user-guides/saml-workflow.md rename to public/docs/02-user-guides/saml-workflow.md diff --git a/docs/02-user-guides/workflow-automation.md b/public/docs/02-user-guides/workflow-automation.md similarity index 100% rename from docs/02-user-guides/workflow-automation.md rename to public/docs/02-user-guides/workflow-automation.md diff --git a/docs/02-user-guides/workflow-interaction.md b/public/docs/02-user-guides/workflow-interaction.md similarity index 100% rename from docs/02-user-guides/workflow-interaction.md rename to public/docs/02-user-guides/workflow-interaction.md diff --git a/docs/03-architecture/README.md b/public/docs/03-architecture/README.md similarity index 100% rename from docs/03-architecture/README.md rename to public/docs/03-architecture/README.md diff --git a/docs/03-architecture/dak-publication-architecture.md b/public/docs/03-architecture/dak-publication-architecture.md similarity index 100% rename from docs/03-architecture/dak-publication-architecture.md rename to public/docs/03-architecture/dak-publication-architecture.md diff --git a/public/docs/fixed-height-layout-requirements.md b/public/docs/03-architecture/fixed-height-layout.md similarity index 100% rename from public/docs/fixed-height-layout-requirements.md rename to public/docs/03-architecture/fixed-height-layout.md diff --git a/public/docs/l2-l3-architecture.md b/public/docs/03-architecture/l2-l3-architecture.md similarity index 100% rename from public/docs/l2-l3-architecture.md rename to public/docs/03-architecture/l2-l3-architecture.md diff --git a/docs/03-architecture/mcp-services/faq-documentation.md b/public/docs/03-architecture/mcp-services/faq-documentation.md similarity index 100% rename from docs/03-architecture/mcp-services/faq-documentation.md rename to public/docs/03-architecture/mcp-services/faq-documentation.md diff --git a/docs/03-architecture/mcp-services/faq-service.md b/public/docs/03-architecture/mcp-services/faq-service.md similarity index 100% rename from docs/03-architecture/mcp-services/faq-service.md rename to public/docs/03-architecture/mcp-services/faq-service.md diff --git a/public/docs/page-framework.md b/public/docs/03-architecture/page-framework-guide.md similarity index 100% rename from public/docs/page-framework.md rename to public/docs/03-architecture/page-framework-guide.md diff --git a/docs/03-architecture/page-framework.md b/public/docs/03-architecture/page-framework.md similarity index 100% rename from docs/03-architecture/page-framework.md rename to public/docs/03-architecture/page-framework.md diff --git a/public/docs/page-inventory.md b/public/docs/03-architecture/page-inventory.md similarity index 100% rename from public/docs/page-inventory.md rename to public/docs/03-architecture/page-inventory.md diff --git a/public/docs/solution-architecture.md b/public/docs/03-architecture/solution-architecture.md similarity index 100% rename from public/docs/solution-architecture.md rename to public/docs/03-architecture/solution-architecture.md diff --git a/public/docs/UI_STYLING_REQUIREMENTS.md b/public/docs/03-architecture/ui-styling-requirements.md similarity index 100% rename from public/docs/UI_STYLING_REQUIREMENTS.md rename to public/docs/03-architecture/ui-styling-requirements.md diff --git a/docs/04-development/README.md b/public/docs/04-development/README.md similarity index 100% rename from docs/04-development/README.md rename to public/docs/04-development/README.md diff --git a/docs/04-development/accessibility.md b/public/docs/04-development/accessibility.md similarity index 100% rename from docs/04-development/accessibility.md rename to public/docs/04-development/accessibility.md diff --git a/docs/04-development/compliance-framework.md b/public/docs/04-development/compliance-framework.md similarity index 100% rename from docs/04-development/compliance-framework.md rename to public/docs/04-development/compliance-framework.md diff --git a/public/docs/CSS_VARIABLES_REFERENCE.md b/public/docs/04-development/css-variables-reference.md similarity index 100% rename from public/docs/CSS_VARIABLES_REFERENCE.md rename to public/docs/04-development/css-variables-reference.md diff --git a/public/docs/framework-developer-guide.md b/public/docs/04-development/framework-developer-guide.md similarity index 100% rename from public/docs/framework-developer-guide.md rename to public/docs/04-development/framework-developer-guide.md diff --git a/docs/04-development/framework-hooks.md b/public/docs/04-development/framework-hooks.md similarity index 100% rename from docs/04-development/framework-hooks.md rename to public/docs/04-development/framework-hooks.md diff --git a/public/docs/qa-testing.md b/public/docs/04-development/qa-testing.md similarity index 100% rename from public/docs/qa-testing.md rename to public/docs/04-development/qa-testing.md diff --git a/public/docs/requirements.md b/public/docs/04-development/requirements.md similarity index 100% rename from public/docs/requirements.md rename to public/docs/04-development/requirements.md diff --git a/public/docs/runtime-validation-integration.md b/public/docs/04-development/runtime-validation-integration.md similarity index 100% rename from public/docs/runtime-validation-integration.md rename to public/docs/04-development/runtime-validation-integration.md diff --git a/public/docs/runtime-validation.md b/public/docs/04-development/runtime-validation.md similarity index 100% rename from public/docs/runtime-validation.md rename to public/docs/04-development/runtime-validation.md diff --git a/public/docs/schema-generation-configuration.md b/public/docs/04-development/schema-generation.md similarity index 100% rename from public/docs/schema-generation-configuration.md rename to public/docs/04-development/schema-generation.md diff --git a/public/docs/typescript-documentation-index.md b/public/docs/04-development/typescript-documentation-index.md similarity index 100% rename from public/docs/typescript-documentation-index.md rename to public/docs/04-development/typescript-documentation-index.md diff --git a/docs/04-development/typescript-migration.md b/public/docs/04-development/typescript-migration.md similarity index 100% rename from docs/04-development/typescript-migration.md rename to public/docs/04-development/typescript-migration.md diff --git a/docs/05-deployment/README.md b/public/docs/05-deployment/README.md similarity index 100% rename from docs/05-deployment/README.md rename to public/docs/05-deployment/README.md diff --git a/public/docs/branch-specific-pr-workflow.md b/public/docs/05-deployment/branch-pr-workflow.md similarity index 100% rename from public/docs/branch-specific-pr-workflow.md rename to public/docs/05-deployment/branch-pr-workflow.md diff --git a/public/docs/build-process-integration.md b/public/docs/05-deployment/build-process-integration.md similarity index 100% rename from public/docs/build-process-integration.md rename to public/docs/05-deployment/build-process-integration.md diff --git a/public/docs/compliance-framework.md b/public/docs/05-deployment/compliance-framework.md similarity index 100% rename from public/docs/compliance-framework.md rename to public/docs/05-deployment/compliance-framework.md diff --git a/docs/05-deployment/github-pages.md b/public/docs/05-deployment/github-pages.md similarity index 100% rename from docs/05-deployment/github-pages.md rename to public/docs/05-deployment/github-pages.md diff --git a/public/docs/multi-branch-deployment-requirements.md b/public/docs/05-deployment/multi-branch-requirements.md similarity index 100% rename from public/docs/multi-branch-deployment-requirements.md rename to public/docs/05-deployment/multi-branch-requirements.md diff --git a/docs/05-deployment/overview.md b/public/docs/05-deployment/overview.md similarity index 100% rename from docs/05-deployment/overview.md rename to public/docs/05-deployment/overview.md diff --git a/public/docs/project-plan.md b/public/docs/05-deployment/project-plan.md similarity index 100% rename from public/docs/project-plan.md rename to public/docs/05-deployment/project-plan.md diff --git a/docs/05-deployment/workflows-analysis.md b/public/docs/05-deployment/workflows-analysis.md similarity index 100% rename from docs/05-deployment/workflows-analysis.md rename to public/docs/05-deployment/workflows-analysis.md diff --git a/docs/06-security/README.md b/public/docs/06-security/README.md similarity index 100% rename from docs/06-security/README.md rename to public/docs/06-security/README.md diff --git a/docs/06-security/additional-tools.md b/public/docs/06-security/additional-tools.md similarity index 100% rename from docs/06-security/additional-tools.md rename to public/docs/06-security/additional-tools.md diff --git a/docs/06-security/codeql-analysis.md b/public/docs/06-security/codeql-analysis.md similarity index 100% rename from docs/06-security/codeql-analysis.md rename to public/docs/06-security/codeql-analysis.md diff --git a/docs/06-security/framework-overlap-analysis.md b/public/docs/06-security/framework-overlap-analysis.md similarity index 100% rename from docs/06-security/framework-overlap-analysis.md rename to public/docs/06-security/framework-overlap-analysis.md diff --git a/docs/06-security/security-check-examples.md b/public/docs/06-security/security-check-examples.md similarity index 100% rename from docs/06-security/security-check-examples.md rename to public/docs/06-security/security-check-examples.md diff --git a/docs/06-security/security-check-implementation.md b/public/docs/06-security/security-check-implementation.md similarity index 100% rename from docs/06-security/security-check-implementation.md rename to public/docs/06-security/security-check-implementation.md diff --git a/docs/06-security/security-check-next-steps.md b/public/docs/06-security/security-check-next-steps.md similarity index 100% rename from docs/06-security/security-check-next-steps.md rename to public/docs/06-security/security-check-next-steps.md diff --git a/docs/06-security/security-checks.md b/public/docs/06-security/security-checks.md similarity index 100% rename from docs/06-security/security-checks.md rename to public/docs/06-security/security-checks.md diff --git a/public/docs/security-headers.md b/public/docs/06-security/security-headers.md similarity index 100% rename from public/docs/security-headers.md rename to public/docs/06-security/security-headers.md diff --git a/public/docs/WHO_CORS_WORKAROUND.md b/public/docs/06-security/who-cors-workaround.md similarity index 100% rename from public/docs/WHO_CORS_WORKAROUND.md rename to public/docs/06-security/who-cors-workaround.md diff --git a/docs/07-features/README.md b/public/docs/07-features/README.md similarity index 100% rename from docs/07-features/README.md rename to public/docs/07-features/README.md diff --git a/public/docs/asset-management.md b/public/docs/07-features/asset-management.md similarity index 100% rename from public/docs/asset-management.md rename to public/docs/07-features/asset-management.md diff --git a/public/docs/bookmark-system.md b/public/docs/07-features/bookmark-system.md similarity index 100% rename from public/docs/bookmark-system.md rename to public/docs/07-features/bookmark-system.md diff --git a/public/docs/bpmn-integration.md b/public/docs/07-features/bpmn-integration.md similarity index 100% rename from public/docs/bpmn-integration.md rename to public/docs/07-features/bpmn-integration.md diff --git a/public/docs/custom-formats-documentation.md b/public/docs/07-features/custom-formats.md similarity index 100% rename from public/docs/custom-formats-documentation.md rename to public/docs/07-features/custom-formats.md diff --git a/public/docs/dak-components.md b/public/docs/07-features/dak-components.md similarity index 100% rename from public/docs/dak-components.md rename to public/docs/07-features/dak-components.md diff --git a/public/docs/decision-table-editor.md b/public/docs/07-features/decision-table-editor.md similarity index 100% rename from public/docs/decision-table-editor.md rename to public/docs/07-features/decision-table-editor.md diff --git a/docs/07-features/future-enhancements.md b/public/docs/07-features/future-enhancements.md similarity index 100% rename from docs/07-features/future-enhancements.md rename to public/docs/07-features/future-enhancements.md diff --git a/docs/07-features/persona-viewer-enhancements.md b/public/docs/07-features/persona-viewer-enhancements.md similarity index 100% rename from docs/07-features/persona-viewer-enhancements.md rename to public/docs/07-features/persona-viewer-enhancements.md diff --git a/public/docs/profile-subscription-system.md b/public/docs/07-features/profile-subscription.md similarity index 100% rename from public/docs/profile-subscription-system.md rename to public/docs/07-features/profile-subscription.md diff --git a/public/docs/tutorial-framework.md b/public/docs/07-features/tutorial-framework.md similarity index 100% rename from public/docs/tutorial-framework.md rename to public/docs/07-features/tutorial-framework.md diff --git a/docs/08-development-history/README.md b/public/docs/08-development-history/README.md similarity index 100% rename from docs/08-development-history/README.md rename to public/docs/08-development-history/README.md diff --git a/docs/08-development-history/deployment-optimization/comment-simplification.md b/public/docs/08-development-history/deployment-optimization/comment-simplification.md similarity index 100% rename from docs/08-development-history/deployment-optimization/comment-simplification.md rename to public/docs/08-development-history/deployment-optimization/comment-simplification.md diff --git a/docs/08-development-history/deployment-optimization/deployment-optimization.md b/public/docs/08-development-history/deployment-optimization/deployment-optimization.md similarity index 100% rename from docs/08-development-history/deployment-optimization/deployment-optimization.md rename to public/docs/08-development-history/deployment-optimization/deployment-optimization.md diff --git a/docs/08-development-history/deployment-optimization/pr-workflow-failure-notifier.md b/public/docs/08-development-history/deployment-optimization/pr-workflow-failure-notifier.md similarity index 100% rename from docs/08-development-history/deployment-optimization/pr-workflow-failure-notifier.md rename to public/docs/08-development-history/deployment-optimization/pr-workflow-failure-notifier.md diff --git a/docs/08-development-history/deployment-optimization/proposed-workflow-changes.md b/public/docs/08-development-history/deployment-optimization/proposed-workflow-changes.md similarity index 100% rename from docs/08-development-history/deployment-optimization/proposed-workflow-changes.md rename to public/docs/08-development-history/deployment-optimization/proposed-workflow-changes.md diff --git a/docs/08-development-history/implementation-summaries/css-phases/css-review-workplan.md b/public/docs/08-development-history/implementation-summaries/css-phases/css-review-workplan.md similarity index 100% rename from docs/08-development-history/implementation-summaries/css-phases/css-review-workplan.md rename to public/docs/08-development-history/implementation-summaries/css-phases/css-review-workplan.md diff --git a/docs/08-development-history/implementation-summaries/css-phases/phase2-completion.md b/public/docs/08-development-history/implementation-summaries/css-phases/phase2-completion.md similarity index 100% rename from docs/08-development-history/implementation-summaries/css-phases/phase2-completion.md rename to public/docs/08-development-history/implementation-summaries/css-phases/phase2-completion.md diff --git a/docs/08-development-history/implementation-summaries/css-phases/phase3-continuation.md b/public/docs/08-development-history/implementation-summaries/css-phases/phase3-continuation.md similarity index 100% rename from docs/08-development-history/implementation-summaries/css-phases/phase3-continuation.md rename to public/docs/08-development-history/implementation-summaries/css-phases/phase3-continuation.md diff --git a/docs/08-development-history/implementation-summaries/css-phases/phase3-final.md b/public/docs/08-development-history/implementation-summaries/css-phases/phase3-final.md similarity index 100% rename from docs/08-development-history/implementation-summaries/css-phases/phase3-final.md rename to public/docs/08-development-history/implementation-summaries/css-phases/phase3-final.md diff --git a/docs/08-development-history/implementation-summaries/css-phases/phase3-progress.md b/public/docs/08-development-history/implementation-summaries/css-phases/phase3-progress.md similarity index 100% rename from docs/08-development-history/implementation-summaries/css-phases/phase3-progress.md rename to public/docs/08-development-history/implementation-summaries/css-phases/phase3-progress.md diff --git a/docs/08-development-history/implementation-summaries/feature-implementations/build-logging-implementation.md b/public/docs/08-development-history/implementation-summaries/feature-implementations/build-logging-implementation.md similarity index 100% rename from docs/08-development-history/implementation-summaries/feature-implementations/build-logging-implementation.md rename to public/docs/08-development-history/implementation-summaries/feature-implementations/build-logging-implementation.md diff --git a/docs/08-development-history/implementation-summaries/feature-implementations/compliance-implementation.md b/public/docs/08-development-history/implementation-summaries/feature-implementations/compliance-implementation.md similarity index 100% rename from docs/08-development-history/implementation-summaries/feature-implementations/compliance-implementation.md rename to public/docs/08-development-history/implementation-summaries/feature-implementations/compliance-implementation.md diff --git a/docs/08-development-history/implementation-summaries/feature-implementations/dak-implementation-status.md b/public/docs/08-development-history/implementation-summaries/feature-implementations/dak-implementation-status.md similarity index 100% rename from docs/08-development-history/implementation-summaries/feature-implementations/dak-implementation-status.md rename to public/docs/08-development-history/implementation-summaries/feature-implementations/dak-implementation-status.md diff --git a/public/docs/dak-publication-api-implementation-summary.md b/public/docs/08-development-history/implementation-summaries/feature-implementations/dak-publication-api.md similarity index 100% rename from public/docs/dak-publication-api-implementation-summary.md rename to public/docs/08-development-history/implementation-summaries/feature-implementations/dak-publication-api.md diff --git a/public/docs/dak-publication-implementation-summary.md b/public/docs/08-development-history/implementation-summaries/feature-implementations/dak-publication.md similarity index 100% rename from public/docs/dak-publication-implementation-summary.md rename to public/docs/08-development-history/implementation-summaries/feature-implementations/dak-publication.md diff --git a/docs/08-development-history/implementation-summaries/feature-implementations/pr-1092-implementation.md b/public/docs/08-development-history/implementation-summaries/feature-implementations/pr-1092-implementation.md similarity index 100% rename from docs/08-development-history/implementation-summaries/feature-implementations/pr-1092-implementation.md rename to public/docs/08-development-history/implementation-summaries/feature-implementations/pr-1092-implementation.md diff --git a/docs/08-development-history/implementation-summaries/feature-implementations/remember-me-implementation.md b/public/docs/08-development-history/implementation-summaries/feature-implementations/remember-me-implementation.md similarity index 100% rename from docs/08-development-history/implementation-summaries/feature-implementations/remember-me-implementation.md rename to public/docs/08-development-history/implementation-summaries/feature-implementations/remember-me-implementation.md diff --git a/docs/08-development-history/implementation-summaries/feature-implementations/routing-implementation-status.md b/public/docs/08-development-history/implementation-summaries/feature-implementations/routing-implementation-status.md similarity index 100% rename from docs/08-development-history/implementation-summaries/feature-implementations/routing-implementation-status.md rename to public/docs/08-development-history/implementation-summaries/feature-implementations/routing-implementation-status.md diff --git a/docs/08-development-history/implementation-summaries/feature-implementations/service-table-implementation.md b/public/docs/08-development-history/implementation-summaries/feature-implementations/service-table-implementation.md similarity index 100% rename from docs/08-development-history/implementation-summaries/feature-implementations/service-table-implementation.md rename to public/docs/08-development-history/implementation-summaries/feature-implementations/service-table-implementation.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-implementation.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-implementation.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-implementation.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-implementation.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-plan.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-plan.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-plan.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/tinymce-migration-plan.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-editor-comparison.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-editor-comparison.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-editor-comparison.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-editor-comparison.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-implementation-guide.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-implementation-guide.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-implementation-guide.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/editor-migration/wysiwyg-implementation-guide.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-improvements-summary.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-improvements-summary.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-improvements-summary.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-improvements-summary.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-migration-implementation.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-migration-implementation.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-migration-implementation.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-migration-implementation.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-upstream-improvements.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-upstream-improvements.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-upstream-improvements.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/mcp-migration/mcp-upstream-improvements.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis-revised.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis-revised.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis-revised.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis-revised.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-analysis.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-status.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-status.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-status.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/service-refactoring-status.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/sushi-refactor-summary.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/sushi-refactor-summary.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/sushi-refactor-summary.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/service-refactoring/sushi-refactor-summary.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/dak-typescript-refactoring.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/dak-typescript-refactoring.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/dak-typescript-refactoring.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/dak-typescript-refactoring.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/faq-typescript-integration.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/faq-typescript-integration.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/faq-typescript-integration.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/faq-typescript-integration.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-6-editor-integration.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-6-editor-integration.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-6-editor-integration.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-6-editor-integration.md diff --git a/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-7-migration-status.md b/public/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-7-migration-status.md similarity index 100% rename from docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-7-migration-status.md rename to public/docs/08-development-history/implementation-summaries/migration-summaries/typescript-refactoring/phase-7-migration-status.md diff --git a/docs/08-development-history/miscellaneous/approval-summary.md b/public/docs/08-development-history/miscellaneous/approval-summary.md similarity index 100% rename from docs/08-development-history/miscellaneous/approval-summary.md rename to public/docs/08-development-history/miscellaneous/approval-summary.md diff --git a/docs/08-development-history/miscellaneous/build-logging-section.md b/public/docs/08-development-history/miscellaneous/build-logging-section.md similarity index 100% rename from docs/08-development-history/miscellaneous/build-logging-section.md rename to public/docs/08-development-history/miscellaneous/build-logging-section.md diff --git a/docs/08-development-history/miscellaneous/copilot-instructions.md b/public/docs/08-development-history/miscellaneous/copilot-instructions.md similarity index 100% rename from docs/08-development-history/miscellaneous/copilot-instructions.md rename to public/docs/08-development-history/miscellaneous/copilot-instructions.md diff --git a/docs/08-development-history/miscellaneous/dak-migration-examples.md b/public/docs/08-development-history/miscellaneous/dak-migration-examples.md similarity index 100% rename from docs/08-development-history/miscellaneous/dak-migration-examples.md rename to public/docs/08-development-history/miscellaneous/dak-migration-examples.md diff --git a/docs/08-development-history/miscellaneous/final-checklist.md b/public/docs/08-development-history/miscellaneous/final-checklist.md similarity index 100% rename from docs/08-development-history/miscellaneous/final-checklist.md rename to public/docs/08-development-history/miscellaneous/final-checklist.md diff --git a/docs/08-development-history/miscellaneous/image-asset-validity-report.md b/public/docs/08-development-history/miscellaneous/image-asset-validity-report.md similarity index 100% rename from docs/08-development-history/miscellaneous/image-asset-validity-report.md rename to public/docs/08-development-history/miscellaneous/image-asset-validity-report.md diff --git a/docs/08-development-history/miscellaneous/implementation-complete-summary.md b/public/docs/08-development-history/miscellaneous/implementation-complete-summary.md similarity index 100% rename from docs/08-development-history/miscellaneous/implementation-complete-summary.md rename to public/docs/08-development-history/miscellaneous/implementation-complete-summary.md diff --git a/docs/08-development-history/miscellaneous/implementation-complete.md b/public/docs/08-development-history/miscellaneous/implementation-complete.md similarity index 100% rename from docs/08-development-history/miscellaneous/implementation-complete.md rename to public/docs/08-development-history/miscellaneous/implementation-complete.md diff --git a/docs/08-development-history/miscellaneous/implementation-status.md b/public/docs/08-development-history/miscellaneous/implementation-status.md similarity index 100% rename from docs/08-development-history/miscellaneous/implementation-status.md rename to public/docs/08-development-history/miscellaneous/implementation-status.md diff --git a/docs/08-development-history/miscellaneous/integration-complete-summary.md b/public/docs/08-development-history/miscellaneous/integration-complete-summary.md similarity index 100% rename from docs/08-development-history/miscellaneous/integration-complete-summary.md rename to public/docs/08-development-history/miscellaneous/integration-complete-summary.md diff --git a/docs/08-development-history/miscellaneous/less-sensitive-fingerprint-options.md b/public/docs/08-development-history/miscellaneous/less-sensitive-fingerprint-options.md similarity index 100% rename from docs/08-development-history/miscellaneous/less-sensitive-fingerprint-options.md rename to public/docs/08-development-history/miscellaneous/less-sensitive-fingerprint-options.md diff --git a/docs/08-development-history/miscellaneous/pr-1060-requirements-checklist.md b/public/docs/08-development-history/miscellaneous/pr-1060-requirements-checklist.md similarity index 100% rename from docs/08-development-history/miscellaneous/pr-1060-requirements-checklist.md rename to public/docs/08-development-history/miscellaneous/pr-1060-requirements-checklist.md diff --git a/docs/08-development-history/miscellaneous/service-table.md b/public/docs/08-development-history/miscellaneous/service-table.md similarity index 100% rename from docs/08-development-history/miscellaneous/service-table.md rename to public/docs/08-development-history/miscellaneous/service-table.md diff --git a/docs/08-development-history/technical-analysis/architecture-analysis/lazy-routing-analysis.md b/public/docs/08-development-history/technical-analysis/architecture-analysis/lazy-routing-analysis.md similarity index 100% rename from docs/08-development-history/technical-analysis/architecture-analysis/lazy-routing-analysis.md rename to public/docs/08-development-history/technical-analysis/architecture-analysis/lazy-routing-analysis.md diff --git a/docs/08-development-history/technical-analysis/compliance-analysis/compliance-analysis.md b/public/docs/08-development-history/technical-analysis/compliance-analysis/compliance-analysis.md similarity index 100% rename from docs/08-development-history/technical-analysis/compliance-analysis/compliance-analysis.md rename to public/docs/08-development-history/technical-analysis/compliance-analysis/compliance-analysis.md diff --git a/docs/08-development-history/technical-analysis/compliance-analysis/compliance-checker-design.md b/public/docs/08-development-history/technical-analysis/compliance-analysis/compliance-checker-design.md similarity index 100% rename from docs/08-development-history/technical-analysis/compliance-analysis/compliance-checker-design.md rename to public/docs/08-development-history/technical-analysis/compliance-analysis/compliance-checker-design.md diff --git a/docs/08-development-history/technical-analysis/compliance-analysis/heuristics-analysis-report.md b/public/docs/08-development-history/technical-analysis/compliance-analysis/heuristics-analysis-report.md similarity index 100% rename from docs/08-development-history/technical-analysis/compliance-analysis/heuristics-analysis-report.md rename to public/docs/08-development-history/technical-analysis/compliance-analysis/heuristics-analysis-report.md diff --git a/docs/08-development-history/technical-analysis/other-analysis/dak-logical-model-update-plan.md b/public/docs/08-development-history/technical-analysis/other-analysis/dak-logical-model-update-plan.md similarity index 100% rename from docs/08-development-history/technical-analysis/other-analysis/dak-logical-model-update-plan.md rename to public/docs/08-development-history/technical-analysis/other-analysis/dak-logical-model-update-plan.md diff --git a/public/docs/dak-publication-options-analysis.md b/public/docs/08-development-history/technical-analysis/other-analysis/dak-publication-options.md similarity index 100% rename from public/docs/dak-publication-options-analysis.md rename to public/docs/08-development-history/technical-analysis/other-analysis/dak-publication-options.md diff --git a/public/docs/dak-publication-technical-spec.md b/public/docs/08-development-history/technical-analysis/other-analysis/dak-publication-spec.md similarity index 100% rename from public/docs/dak-publication-technical-spec.md rename to public/docs/08-development-history/technical-analysis/other-analysis/dak-publication-spec.md diff --git a/public/docs/dak-publication-wysiwyg-analysis.md b/public/docs/08-development-history/technical-analysis/other-analysis/dak-publication-wysiwyg.md similarity index 100% rename from public/docs/dak-publication-wysiwyg-analysis.md rename to public/docs/08-development-history/technical-analysis/other-analysis/dak-publication-wysiwyg.md diff --git a/docs/08-development-history/technical-analysis/other-analysis/geolocation-analysis.md b/public/docs/08-development-history/technical-analysis/other-analysis/geolocation-analysis.md similarity index 100% rename from docs/08-development-history/technical-analysis/other-analysis/geolocation-analysis.md rename to public/docs/08-development-history/technical-analysis/other-analysis/geolocation-analysis.md diff --git a/docs/08-development-history/technical-analysis/other-analysis/merge-conflict-analysis.md b/public/docs/08-development-history/technical-analysis/other-analysis/merge-conflict-analysis.md similarity index 100% rename from docs/08-development-history/technical-analysis/other-analysis/merge-conflict-analysis.md rename to public/docs/08-development-history/technical-analysis/other-analysis/merge-conflict-analysis.md diff --git a/docs/08-development-history/technical-analysis/other-analysis/merge-conflict-resolution-proposal.md b/public/docs/08-development-history/technical-analysis/other-analysis/merge-conflict-resolution-proposal.md similarity index 100% rename from docs/08-development-history/technical-analysis/other-analysis/merge-conflict-resolution-proposal.md rename to public/docs/08-development-history/technical-analysis/other-analysis/merge-conflict-resolution-proposal.md diff --git a/docs/08-development-history/technical-analysis/other-analysis/typescript-migration-plan.md b/public/docs/08-development-history/technical-analysis/other-analysis/typescript-migration-plan.md similarity index 100% rename from docs/08-development-history/technical-analysis/other-analysis/typescript-migration-plan.md rename to public/docs/08-development-history/technical-analysis/other-analysis/typescript-migration-plan.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/route-configuration.md b/public/docs/08-development-history/technical-analysis/routing-analysis/route-configuration.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/route-configuration.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/route-configuration.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/routing-analysis.md b/public/docs/08-development-history/technical-analysis/routing-analysis/routing-analysis.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/routing-analysis.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/routing-analysis.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/routing-consolidation-proposal.md b/public/docs/08-development-history/technical-analysis/routing-analysis/routing-consolidation-proposal.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/routing-consolidation-proposal.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/routing-consolidation-proposal.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/routing-documentation-audit.md b/public/docs/08-development-history/technical-analysis/routing-analysis/routing-documentation-audit.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/routing-documentation-audit.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/routing-documentation-audit.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/routing-implementation-guide.md b/public/docs/08-development-history/technical-analysis/routing-analysis/routing-implementation-guide.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/routing-implementation-guide.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/routing-implementation-guide.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/routing-logic-workflow-diagram.md b/public/docs/08-development-history/technical-analysis/routing-analysis/routing-logic-workflow-diagram.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/routing-logic-workflow-diagram.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/routing-logic-workflow-diagram.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/routing-migration-plan.md b/public/docs/08-development-history/technical-analysis/routing-analysis/routing-migration-plan.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/routing-migration-plan.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/routing-migration-plan.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/routing-plan-finalized.md b/public/docs/08-development-history/technical-analysis/routing-analysis/routing-plan-finalized.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/routing-plan-finalized.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/routing-plan-finalized.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/routing-solution-proposal.md b/public/docs/08-development-history/technical-analysis/routing-analysis/routing-solution-proposal.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/routing-solution-proposal.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/routing-solution-proposal.md diff --git a/docs/08-development-history/technical-analysis/routing-analysis/routing-solution-summary.md b/public/docs/08-development-history/technical-analysis/routing-analysis/routing-solution-summary.md similarity index 100% rename from docs/08-development-history/technical-analysis/routing-analysis/routing-solution-summary.md rename to public/docs/08-development-history/technical-analysis/routing-analysis/routing-solution-summary.md diff --git a/docs/08-development-history/technical-analysis/security-analysis/localstorage-security-analysis.md b/public/docs/08-development-history/technical-analysis/security-analysis/localstorage-security-analysis.md similarity index 100% rename from docs/08-development-history/technical-analysis/security-analysis/localstorage-security-analysis.md rename to public/docs/08-development-history/technical-analysis/security-analysis/localstorage-security-analysis.md diff --git a/docs/08-development-history/technical-analysis/security-analysis/sessionstorage-cross-tab-solution.md b/public/docs/08-development-history/technical-analysis/security-analysis/sessionstorage-cross-tab-solution.md similarity index 100% rename from docs/08-development-history/technical-analysis/security-analysis/sessionstorage-cross-tab-solution.md rename to public/docs/08-development-history/technical-analysis/security-analysis/sessionstorage-cross-tab-solution.md diff --git a/docs/08-development-history/test-documentation/debug-faq-test.md b/public/docs/08-development-history/test-documentation/debug-faq-test.md similarity index 100% rename from docs/08-development-history/test-documentation/debug-faq-test.md rename to public/docs/08-development-history/test-documentation/debug-faq-test.md diff --git a/docs/08-development-history/test-documentation/phase-7-testing.md b/public/docs/08-development-history/test-documentation/phase-7-testing.md similarity index 100% rename from docs/08-development-history/test-documentation/phase-7-testing.md rename to public/docs/08-development-history/test-documentation/phase-7-testing.md diff --git a/docs/08-development-history/test-documentation/pr-feedback-tests/test-improved-pr-feedback.md b/public/docs/08-development-history/test-documentation/pr-feedback-tests/test-improved-pr-feedback.md similarity index 100% rename from docs/08-development-history/test-documentation/pr-feedback-tests/test-improved-pr-feedback.md rename to public/docs/08-development-history/test-documentation/pr-feedback-tests/test-improved-pr-feedback.md diff --git a/docs/08-development-history/test-documentation/pr-feedback-tests/test-pr-feedback.md b/public/docs/08-development-history/test-documentation/pr-feedback-tests/test-pr-feedback.md similarity index 100% rename from docs/08-development-history/test-documentation/pr-feedback-tests/test-pr-feedback.md rename to public/docs/08-development-history/test-documentation/pr-feedback-tests/test-pr-feedback.md diff --git a/docs/08-development-history/test-documentation/pr-feedback-tests/test-session-feedback.md b/public/docs/08-development-history/test-documentation/pr-feedback-tests/test-session-feedback.md similarity index 100% rename from docs/08-development-history/test-documentation/pr-feedback-tests/test-session-feedback.md rename to public/docs/08-development-history/test-documentation/pr-feedback-tests/test-session-feedback.md diff --git a/docs/08-development-history/test-documentation/pr-feedback-tests/test-simplified-pr-comments.md b/public/docs/08-development-history/test-documentation/pr-feedback-tests/test-simplified-pr-comments.md similarity index 100% rename from docs/08-development-history/test-documentation/pr-feedback-tests/test-simplified-pr-comments.md rename to public/docs/08-development-history/test-documentation/pr-feedback-tests/test-simplified-pr-comments.md diff --git a/docs/08-development-history/test-documentation/test-failure-notification-example.md b/public/docs/08-development-history/test-documentation/test-failure-notification-example.md similarity index 100% rename from docs/08-development-history/test-documentation/test-failure-notification-example.md rename to public/docs/08-development-history/test-documentation/test-failure-notification-example.md diff --git a/docs/08-development-history/ticket-fixes/404-routing/404-implementation.md b/public/docs/08-development-history/ticket-fixes/404-routing/404-implementation.md similarity index 100% rename from docs/08-development-history/ticket-fixes/404-routing/404-implementation.md rename to public/docs/08-development-history/ticket-fixes/404-routing/404-implementation.md diff --git a/docs/08-development-history/ticket-fixes/404-routing/always-build-pages-fix-883.md b/public/docs/08-development-history/ticket-fixes/404-routing/always-build-pages-fix-883.md similarity index 100% rename from docs/08-development-history/ticket-fixes/404-routing/always-build-pages-fix-883.md rename to public/docs/08-development-history/ticket-fixes/404-routing/always-build-pages-fix-883.md diff --git a/docs/08-development-history/ticket-fixes/404-routing/badge-icon-path-fix.md b/public/docs/08-development-history/ticket-fixes/404-routing/badge-icon-path-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/404-routing/badge-icon-path-fix.md rename to public/docs/08-development-history/ticket-fixes/404-routing/badge-icon-path-fix.md diff --git a/docs/08-development-history/ticket-fixes/404-routing/url-routing-fix.md b/public/docs/08-development-history/ticket-fixes/404-routing/url-routing-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/404-routing/url-routing-fix.md rename to public/docs/08-development-history/ticket-fixes/404-routing/url-routing-fix.md diff --git a/docs/08-development-history/ticket-fixes/authentication/page-reload-token-loss.md b/public/docs/08-development-history/ticket-fixes/authentication/page-reload-token-loss.md similarity index 100% rename from docs/08-development-history/ticket-fixes/authentication/page-reload-token-loss.md rename to public/docs/08-development-history/ticket-fixes/authentication/page-reload-token-loss.md diff --git a/docs/08-development-history/ticket-fixes/authentication/pat-token-debugging.md b/public/docs/08-development-history/ticket-fixes/authentication/pat-token-debugging.md similarity index 100% rename from docs/08-development-history/ticket-fixes/authentication/pat-token-debugging.md rename to public/docs/08-development-history/ticket-fixes/authentication/pat-token-debugging.md diff --git a/docs/08-development-history/ticket-fixes/authentication/pat-token-flow-analysis.md b/public/docs/08-development-history/ticket-fixes/authentication/pat-token-flow-analysis.md similarity index 100% rename from docs/08-development-history/ticket-fixes/authentication/pat-token-flow-analysis.md rename to public/docs/08-development-history/ticket-fixes/authentication/pat-token-flow-analysis.md diff --git a/docs/08-development-history/ticket-fixes/authentication/pat-token-investigation.md b/public/docs/08-development-history/ticket-fixes/authentication/pat-token-investigation.md similarity index 100% rename from docs/08-development-history/ticket-fixes/authentication/pat-token-investigation.md rename to public/docs/08-development-history/ticket-fixes/authentication/pat-token-investigation.md diff --git a/docs/08-development-history/ticket-fixes/authentication/pat-token-loss-investigation.md b/public/docs/08-development-history/ticket-fixes/authentication/pat-token-loss-investigation.md similarity index 100% rename from docs/08-development-history/ticket-fixes/authentication/pat-token-loss-investigation.md rename to public/docs/08-development-history/ticket-fixes/authentication/pat-token-loss-investigation.md diff --git a/docs/08-development-history/ticket-fixes/deployment/branch-deployment-fix.md b/public/docs/08-development-history/ticket-fixes/deployment/branch-deployment-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/deployment/branch-deployment-fix.md rename to public/docs/08-development-history/ticket-fixes/deployment/branch-deployment-fix.md diff --git a/docs/08-development-history/ticket-fixes/deployment/deploy-branch-eslint-fix.md b/public/docs/08-development-history/ticket-fixes/deployment/deploy-branch-eslint-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/deployment/deploy-branch-eslint-fix.md rename to public/docs/08-development-history/ticket-fixes/deployment/deploy-branch-eslint-fix.md diff --git a/docs/08-development-history/ticket-fixes/deployment/deploy-branch-fix.md b/public/docs/08-development-history/ticket-fixes/deployment/deploy-branch-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/deployment/deploy-branch-fix.md rename to public/docs/08-development-history/ticket-fixes/deployment/deploy-branch-fix.md diff --git a/docs/08-development-history/ticket-fixes/deployment/deployment-fix-625.md b/public/docs/08-development-history/ticket-fixes/deployment/deployment-fix-625.md similarity index 100% rename from docs/08-development-history/ticket-fixes/deployment/deployment-fix-625.md rename to public/docs/08-development-history/ticket-fixes/deployment/deployment-fix-625.md diff --git a/docs/08-development-history/ticket-fixes/deployment/deployment-fix-691.md b/public/docs/08-development-history/ticket-fixes/deployment/deployment-fix-691.md similarity index 100% rename from docs/08-development-history/ticket-fixes/deployment/deployment-fix-691.md rename to public/docs/08-development-history/ticket-fixes/deployment/deployment-fix-691.md diff --git a/docs/08-development-history/ticket-fixes/deployment/preview-builds-fix.md b/public/docs/08-development-history/ticket-fixes/deployment/preview-builds-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/deployment/preview-builds-fix.md rename to public/docs/08-development-history/ticket-fixes/deployment/preview-builds-fix.md diff --git a/docs/08-development-history/ticket-fixes/other-fixes/eslint-fix-summary.md b/public/docs/08-development-history/ticket-fixes/other-fixes/eslint-fix-summary.md similarity index 100% rename from docs/08-development-history/ticket-fixes/other-fixes/eslint-fix-summary.md rename to public/docs/08-development-history/ticket-fixes/other-fixes/eslint-fix-summary.md diff --git a/docs/08-development-history/ticket-fixes/other-fixes/routing-fix-plan.md b/public/docs/08-development-history/ticket-fixes/other-fixes/routing-fix-plan.md similarity index 100% rename from docs/08-development-history/ticket-fixes/other-fixes/routing-fix-plan.md rename to public/docs/08-development-history/ticket-fixes/other-fixes/routing-fix-plan.md diff --git a/docs/08-development-history/ticket-fixes/other-fixes/who-repo-scanning-fix.md b/public/docs/08-development-history/ticket-fixes/other-fixes/who-repo-scanning-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/other-fixes/who-repo-scanning-fix.md rename to public/docs/08-development-history/ticket-fixes/other-fixes/who-repo-scanning-fix.md diff --git a/docs/08-development-history/ticket-fixes/ui-fixes/bpmn-display-fix.md b/public/docs/08-development-history/ticket-fixes/ui-fixes/bpmn-display-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/ui-fixes/bpmn-display-fix.md rename to public/docs/08-development-history/ticket-fixes/ui-fixes/bpmn-display-fix.md diff --git a/docs/08-development-history/ticket-fixes/ui-fixes/dark-mode-image-audit.md b/public/docs/08-development-history/ticket-fixes/ui-fixes/dark-mode-image-audit.md similarity index 100% rename from docs/08-development-history/ticket-fixes/ui-fixes/dark-mode-image-audit.md rename to public/docs/08-development-history/ticket-fixes/ui-fixes/dark-mode-image-audit.md diff --git a/docs/08-development-history/ticket-fixes/workflow-fixes/pr-title-preservation-fix.md b/public/docs/08-development-history/ticket-fixes/workflow-fixes/pr-title-preservation-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/workflow-fixes/pr-title-preservation-fix.md rename to public/docs/08-development-history/ticket-fixes/workflow-fixes/pr-title-preservation-fix.md diff --git a/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-fix.md b/public/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-fix.md rename to public/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-fix.md diff --git a/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-marker-fix.md b/public/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-marker-fix.md similarity index 100% rename from docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-marker-fix.md rename to public/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-comment-marker-fix.md diff --git a/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-concurrency-fix-841.md b/public/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-concurrency-fix-841.md similarity index 100% rename from docs/08-development-history/ticket-fixes/workflow-fixes/workflow-concurrency-fix-841.md rename to public/docs/08-development-history/ticket-fixes/workflow-fixes/workflow-concurrency-fix-841.md diff --git a/docs/dak/faq/component-questions-draft.md b/public/docs/dak/faq/component-questions-draft.md similarity index 100% rename from docs/dak/faq/component-questions-draft.md rename to public/docs/dak/faq/component-questions-draft.md diff --git a/docs/dak/faq/implementation-summary.md b/public/docs/dak/faq/implementation-summary.md similarity index 100% rename from docs/dak/faq/implementation-summary.md rename to public/docs/dak/faq/implementation-summary.md diff --git a/docs/dak/faq/parameters/registry.yaml b/public/docs/dak/faq/parameters/registry.yaml similarity index 100% rename from docs/dak/faq/parameters/registry.yaml rename to public/docs/dak/faq/parameters/registry.yaml