Skip to content

site_map

Jump to bottom
Robert Trenaman edited this page May 7, 2026 · 2 revisions

SCRIBE Wiki Site Map

Complete Wiki Structure

docs/wiki/
├── README.md                    # Main wiki index
├── SITE_MAP.md                  # This file - complete site map
├── architecture/
│   └── README.md                # System architecture documentation
├── components/
│   └── README.md                # Component documentation
├── api/
│   └── README.md                # API documentation
├── user-guide/
│   └── README.md                # User guide
├── developer/
│   └── README.md                # Developer documentation
├── troubleshooting/
│   └── README.md                # Troubleshooting guide
└── deployment/
    └── README.md                # Deployment guide

🗺️ Navigation Flow

Main Entry Points

  1. Main Wiki Index - Primary entry point
  2. System Architecture - Technical overview
  3. User Guide - Getting started guide
  4. API Documentation - API reference

User Journey Paths

New User Path

  1. Main Wiki Index → User Guide → Troubleshooting

Developer Path

  1. Main Wiki Index → Developer Documentation → System Architecture

API User Path

  1. Main Wiki Index → API Documentation → Deployment Guide

System Administrator Path

  1. Main Wiki Index → Deployment Guide → Troubleshooting

Cross-References

Architecture Links

Component Links

API Links

User Guide Links

Developer Links

Troubleshooting Links

Deployment Links

Content Categories

Overview Documentation

User Documentation

Technical Documentation

Operations Documentation

Quick Access

For Users

For Developers

For System Administrators

For API Users

Search Guide

Finding Information

  1. Start at Main Index - README.md
  2. Use Site Map - This file for complete overview
  3. Follow User Journey - Choose appropriate path above
  4. Cross-Reference - Use links in each document

Common Searches

Maintenance Notes

Updating the Wiki

  1. Update relevant documentation files
  2. Update cross-references in linked documents
  3. Update this site map if structure changes
  4. Test all links and navigation paths

Link Validation

  • All internal links use relative paths
  • External links open in new tabs
  • Cross-references are maintained in each document
  • Navigation flows are tested regularly

Version Control

  • All documentation is version controlled
  • Major updates include version information
  • Breaking changes are clearly marked
  • Archive versions are maintained for reference

Last Updated: 2026-05-06
Site Map Version: 1.0.0
Total Pages: 8 main pages + 1 index

Clone this wiki locally