feat(docs): set up VitePress documentation site with Mermaid and ASD-STE100 compliance - #21
Merged
Merged
Conversation
added 2 commits
September 7, 2026 23:43
…STE100 compliance - Initialize VitePress 1.6.4 with vitepress-plugin-mermaid for interactive architectural diagrams - Add automated GitHub Pages deployment workflow (.github/workflows/deploy-docs.yml) - Rewrite documentation following ASD-STE100 Simplified Technical English (Issue 9) standards - Add comprehensive User Guide with desktop component screenshots for all primary workflows - Add complete Software Requirements Specification (SRS) with 923-test traceability matrix - Add interactive Mermaid diagrams for system components, data ingestion pipelines, and database ERD - Add MCP tools reference, Admin REST API specification, and developer contributor guides
…eering archetype - Add scripts/verify_release.py validating manifest versions and relative markdown link integrity - Add .github/workflows/ci.yml implementing 4-stage quality gates: - Stage 1: Release & Link Integrity Gate (verify_release.py) - Stage 2A: Backend Build, Tests & Coverage (Python 3.12 / pytest) - Stage 2B: Frontend Quality, Lint, Typecheck, Build, Vitest & Playwright Layout Inspector - Stage 2C: Documentation Quality & VitePress Build - Stage 3: Fullstack Integration Smoke Gate with live server health probing - Add .github/workflows/codeql.yml for Python and TypeScript CodeQL security analysis
Owner
Author
🚀 CI Quality Gates Update per Engineering ArchetypePushed commit
|
|
You are seeing this message because GitHub Code Scanning has recently been set up for this repository, or this pull request contains the workflow file for the Code Scanning tool. What Enabling Code Scanning Means:
For more information about GitHub Code Scanning, check out the documentation. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR establishes an interactive documentation site for ContextCortex using VitePress and Mermaid, rewritten and structured according to the ASD-STE100 Simplified Technical English (Issue 9) standard.
Deliverables & Key Changes
VitePress & Mermaid Integration:
vitepress-plugin-mermaidandmermaid11.17.2 in rootpackage.json.docs/.vitepress/config.mtswithwithMermaid, complete navigation bars, multi-section sidebars, and local search.docs:dev,docs:build, anddocs:preview..github/workflows/deploy-docs.yml.ASD-STE100 (Issue 9) Technical Writing:
README.md,ARCHITECTURE.md,DEVELOPER_DOCS.md) to reference the interactive site and meet STE criteria.Documentation Gaps Filled:
docs/guide/user-guide.md):docs/requirements/):Verification
npm run docs:buildsuccessfully compiled client and server bundles and rendered all pages in 16.5s.pytest tests/backend/test_requirements_sync.pypassed with 100% success.