Skip to content

feat(docs): set up VitePress documentation site with Mermaid and ASD-STE100 compliance - #21

Merged
spelech merged 4 commits into
mainfrom
feat/vitepress-documentation-site
Sep 8, 2026
Merged

feat(docs): set up VitePress documentation site with Mermaid and ASD-STE100 compliance#21
spelech merged 4 commits into
mainfrom
feat/vitepress-documentation-site

Conversation

@spelech

@spelech spelech commented Sep 8, 2026

Copy link
Copy Markdown
Owner

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

  1. VitePress & Mermaid Integration:

    • Initialized VitePress 1.6.4 with vitepress-plugin-mermaid and mermaid 11.17.2 in root package.json.
    • Configured docs/.vitepress/config.mts with withMermaid, complete navigation bars, multi-section sidebars, and local search.
    • Added npm scripts: docs:dev, docs:build, and docs:preview.
    • Added automated GitHub Pages deployment workflow in .github/workflows/deploy-docs.yml.
  2. ASD-STE100 (Issue 9) Technical Writing:

    • Applied core rules: max 20 words per procedural sentence, max 25 words per descriptive sentence, active voice, no contractions, clear imperative mood, and zero semicolons.
    • Aligned existing documentation (README.md, ARCHITECTURE.md, DEVELOPER_DOCS.md) to reference the interactive site and meet STE criteria.
  3. Documentation Gaps Filled:

    • Comprehensive User Guide with Screenshots (docs/guide/user-guide.md):
      • Overview Dashboard (metrics, vector counts, topic tag cloud)
      • 3-Pane Codebase Navigator (File Tree, Symbol Outline, Code Impact/Route Inspector, density settings)
      • Search & Inspector (Hybrid Dense + BM25, RRF scoring, permalinks)
      • Git Repositories (multivendor Git support, shallow clones)
      • Local Paths & Monitored Vaults
      • Local Storage & PDF Ingestion (PDF preview modal, AI vision OCR)
      • Settings & Dynamic Model Discovery (LiteLLM classification, Git Credential Vault)
      • Diagnostics & Observability (in-memory ring buffer, error traces)
      • Multi-Theme Customization (Deep Ocean, Midnight Blue, Lavender Haze, Amber Warmth)
    • Software Requirements Specification (SRS) (docs/requirements/):
      • Comprehensive SRS document following ISO/IEC/IEEE 29148 and ASD-STE100 standards.
      • 15 Detailed Functional Requirements (FR-01 through FR-15).
      • 8 Non-Functional Requirements (NFR-01 through NFR-08).
      • Traceability matrix mapped to the 923-test automated test suite (611 Backend + 266 Frontend + 46 Playwright E2E).
    • Interactive Mermaid Architecture Diagrams:
      • High-Level System Architecture and Component Topology
      • Data Ingestion & Repository Synchronization Sequence Diagram
      • Hybrid Retrieval (Dense + BM25) and RRF Flowchart
      • PDF Ingestion & AI Vision OCR Fallback Flowchart
      • FastMCP 2.0 Dual Transport and OAuth 2.1 Security Engine Flowchart
      • Unified Relational Data Model (ERD)
    • Reference Manuals:
      • 14 MCP Tools & Dynamic Resources Reference
      • Admin REST API Reference
      • Developer & Contributor Guide

Verification

  • npm run docs:build successfully compiled client and server bundles and rendered all pages in 16.5s.
  • pytest tests/backend/test_requirements_sync.py passed with 100% success.
  • Do not merge right away as requested by the user.

Antigravity Agent 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
@spelech

spelech commented Sep 8, 2026

Copy link
Copy Markdown
Owner Author

🚀 CI Quality Gates Update per Engineering Archetype

Pushed commit 01cb586 adding the full multi-stage CI quality gate suite and CodeQL security workflow:

  • scripts/verify_release.py: Stage 1 Release & Link Integrity Gate (validated across all 7 manifests and 43 markdown relative links)
  • .github/workflows/ci.yml:
    • Stage 1: Release & Link Integrity Gate (verify_release.py --ci)
    • Stage 2A: Backend Build, Tests & Coverage (Python 3.12 / Pytest with coverage artifact)
    • Stage 2B: Frontend Quality, Lint, Typecheck, Build, Vitest & Playwright Layout Inspector (Node 22)
    • Stage 2C: Documentation Quality & VitePress Build (Node 22)
    • Stage 3: Fullstack Integration Smoke Gate with live server health probing and RFC 9728 discovery validation
  • .github/workflows/codeql.yml: Stage 4 Automated Security Analysis (Python + TypeScript matrix)

@github-advanced-security

Copy link
Copy Markdown

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:

  • The 'Security' tab will display more code scanning analysis results (e.g., for the default branch).
  • Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results.
  • You will be able to see the analysis results for the pull request's branch on this overview once the scans have completed and the checks have passed.

For more information about GitHub Code Scanning, check out the documentation.

@spelech
spelech merged commit 40274fa into main Sep 8, 2026
15 checks passed
@spelech
spelech deleted the feat/vitepress-documentation-site branch September 8, 2026 05:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants