Sankofa/docs

Sankofa Phoenix Documentation

Complete documentation for the Sankofa Phoenix sovereign cloud platform.

Quick Links

• Main README - Project overview and getting started
• Configuration Guide - Setup and configuration
• Environment Variables - Environment variable examples

Documentation Structure

Guides

• Guides Directory - Step-by-step guides and how-to documentation
  • Build and Deploy Instructions
  • Force Unlock Instructions
  • Guest Agent Guides

Reference

• Reference Directory - Reference materials and specifications
  • Code Inconsistencies
  • Script Documentation

Reports

• Reports Directory - Audit reports, reviews, and analysis
  • Audit Reports
  • Review Reports
  • Documentation Reports

Summaries

• Summaries Directory - Completion and implementation summaries
  • Documentation Complete Summary
  • Implementation Summary

Deployment

• Deployment Directory - Deployment status and planning
  • Deployment Next Steps
  • Deployment Ready
  • Pre-Deployment Checklist

VM Documentation

• VM Directory - Virtual Machine documentation
  • VM Creation Procedure
  • VM Deployment Checklist
  • VM Specifications

Guest Agent

• Guest Agent Directory - Guest agent documentation
  • Guest Agent Checklist
  • Guest Agent Configuration Analysis

Architecture

• System Architecture - Overall system architecture
• Ecosystem Architecture - Ecosystem structure
• Datacenter Architecture - Datacenter specifications
• Blockchain Architecture - Blockchain integration
• Data Model - GraphQL schema and data model
• Tech Stack - Technology stack details

Infrastructure

• Infrastructure README - Infrastructure management overview
• Proxmox Documentation - Complete Proxmox documentation
  • Quick Start - Get started with Proxmox
  • Deployment Guide - Deployment procedures
  • Configuration - Configuration guides
• Domain Migration - Domain migration documentation

Development

• Development Guide - Development setup and workflow
• Testing Guide - Testing strategies and examples
• Deployment Guide - Production deployment instructions
• Troubleshooting Guide - Comprehensive troubleshooting guide

Deployment & Status

• Deployment Requirements - Complete deployment requirements
• Deployment Execution Plan - Step-by-step execution guide
• Deployment Index - Navigation guide
• Infrastructure Ready - Current infrastructure status
• Deployment Guide - Production deployment instructions

Operations

• Runbooks - Operational runbooks
  • VM Provisioning
  • Troubleshooting
  • Disaster Recovery

Brand & Positioning

• Brand Documentation - Brand philosophy and positioning
• Ecosystem Mapping - Ecosystem structure

Tenants (Multi-Tenancy)

• Tenant Management - Comprehensive tenant management guide
• Billing Guide - Advanced billing features (superior to Azure)
• Identity Setup - Keycloak and identity provider setup
• Azure Migration Guide - Guide for migrating from Azure

Key Features

Sovereign Infrastructure

• NO Azure/Microsoft dependencies - All solutions are self-hosted
• Superior to Azure - More flexible, granular, and better UX than Azure
• Sovereign-owned hardware - Complete control over infrastructure

Multi-Tenancy

• Keycloak-based identity - Sovereign alternative to Azure AD
• Fine-grained permissions - Beyond Azure RBAC
• Custom domains per tenant - Better than Azure
• Cross-tenant resource sharing - More flexible than Azure

Billing (Superior to Azure Cost Management)

• Per-second granularity - vs Azure's hourly
• Real-time cost tracking - Better than Azure
• ML-based forecasting - Predictive cost analysis
• Blockchain-backed billing - Immutable audit trail

Current Status

• Infrastructure Ready - Current infrastructure status
• Deployment Guide - Production deployment instructions
• Status Reports - Current status reports by category
  • Build Status - Build and test results
  • Deployment Status - Deployment status reports
  • VM Status - VM-related status and analysis
  • Tasks - Task tracking and remaining work
• Archived Reports - Historical reports and audits

SMOM-DBIS-138

• SMOM-DBIS-138 Index - Navigation guide
• SMOM-DBIS-138 Quick Start - Quick start guide
• SMOM-DBIS-138 Next Steps - Next steps guide
• SMOM-DBIS-138 Project Integration - Integration guide
• SMOM-DBIS-138 Complete Summary - Complete summary (archived)

Archive

Historical documentation is archived in docs/archive/ for reference:

• Audit Reports - Historical audit reports
• Status Reports - Archived status reports
• Build Results - Historical build results
• Deployment Reports - Historical deployment reports

Documentation Index

• Markdown Reference Index - Complete index of all Markdown files with headings and line numbers
• Markdown Deduplication Report - Analysis of documentation organization and deduplication
• Markdown Reference JSON - Machine-readable index (JSON format)
• Documentation Organization - Guide to documentation structure and organization

Documentation Indexes

Quick navigation to specific documentation types:

• Guides Index - All how-to guides and tutorials
• Reference Index - API docs, specs, and reference material
• Architecture Index - Architecture and design documentation

Documentation Maintenance

For documentation improvements and audits, see:

• Documentation Deep-Dive Analysis - Comprehensive documentation analysis
• Documentation Fixes Applied - Recent documentation improvements
• Audit Summary - Quick audit reference