​

Documentation Site Generator

​

Command

arckit pages <project ID or 'all'>

​

Arguments

• scope (optional): Project ID or “all” for all projects (default: all)

​

Examples

arckit pages
arckit pages "001"
arckit pages "all"

​

Purpose

• Dashboard with KPI cards, donut charts, coverage bars, and governance checklist
• Displays all ArcKit artifacts in a navigable web interface
• Renders Mermaid diagrams inline
• Organizes documents by project with sidebar navigation
• Follows GOV.UK Design System styling
• Works with any static hosting provider (GitHub Pages, Netlify, Vercel, S3, etc.)

​

What’s Generated

​

Files Created

1. docs/index.html - Main page with dashboard and document viewer
2. docs/manifest.json - Document index with metadata

​

Features

• KPI cards: Total projects, total documents, completion percentage, compliance score
• Category donut charts: Document distribution by category
• Coverage bars: Requirements coverage, traceability, compliance
• Governance checklist: Quick status of key governance artifacts
• Project table: List of all projects with document counts

• Sidebar navigation for all projects
• Markdown rendering with syntax highlighting
• Mermaid diagram support (auto-rendered)
• Search functionality
• Responsive mobile layout

• GOV.UK Design System colors and typography
• Professional, accessible design
• Mobile-responsive

​

Document Organization

​

Global Documents

projects/000-global/
├── ARC-000-PRIN-v1.0.md    # Architecture Principles
├── policies/                # Governance policies
└── external/                # Enterprise reference documents

​

Project Documents

projects/001-project-name/
├── ARC-001-REQ-v1.0.md      # Requirements
├── ARC-001-STKE-v1.0.md     # Stakeholder Drivers
├── ARC-001-RISK-v1.0.md     # Risk Register
├── diagrams/
│   └── ARC-001-DIAG-*.md    # Architecture Diagrams
├── decisions/
│   └── ARC-001-ADR-*.md     # ADRs
├── reviews/
│   ├── ARC-001-HLDR-v1.0.md # HLD Review
│   └── ARC-001-DLDR-v1.0.md # DLD Review
├── vendors/
│   └── {vendor}/
│       ├── hld-v1.md
│       └── dld-v1.md
└── external/
    └── rfp-document.pdf

​

Known Artifact Types

​

Deployment Options

​

GitHub Pages

1. Go to Settings > Pages
2. Source: “Deploy from branch”
3. Branch: “main”, folder: “/docs”
4. Save
5. Access at https://{username}.github.io/{repo}/

​

Netlify

1. New site from Git
2. Build command: (leave empty)
3. Publish directory: / (root - serves docs/index.html)
4. Deploy

​

Vercel

1. Import Git repository
2. Framework: Other
3. Root directory: /
4. Output directory: (leave default)
5. Deploy

​

AWS S3 + CloudFront

1. Create S3 bucket
2. Upload entire repository
3. Enable static website hosting
4. Index document: docs/index.html
5. Configure CloudFront distribution (optional)

​

Health Integration

# Generate health data
arckit health JSON=true

# Regenerate pages to include health data
arckit pages

​

Prerequisites

• Syncs all guide .md files from plugin to docs/guides/
• Extracts titles from each guide
• Reads .git/config for repo name, owner, URL
• Reads plugin VERSION
• Processes pages-template.html → writes docs/index.html
• Scans all projects, artifacts, vendors, external files → writes docs/manifest.json

​

Example Output

Documentation Site Generated

Files Created:
- docs/index.html (main page)
- docs/manifest.json (document index)

Repository: arckit-project
Projects Found: 3
Documents Indexed: 87

Document Breakdown:
- Guides: 45
- DDaT Role Guides: 18
- Global: 1
- Project Documents: 23
- Diagrams: 8
- ADRs: 12
- Wardley Maps: 5
- Reviews: 6
- Vendor Documents: 15

Features:
- Dashboard view (default landing page)
- Sidebar navigation
- Markdown rendering with syntax highlighting
- Mermaid diagram support
- GOV.UK Design System styling
- Responsive mobile layout

Deployment:
- GitHub Pages: Settings > Pages > Deploy from /docs
- Netlify/Vercel: Set publish directory to root
- Works on any static hosting provider

​

Related Commands

• arckit health - Generate health.json for dashboard integration
• arckit story - Generate comprehensive project story
• arckit presentation - Generate MARP presentation slides

​

Resources

• MARP - Presentation rendering
• Mermaid - Diagram syntax
• GOV.UK Design System