Documentation Library
Technical guides, architecture docs, and reference materials.
Architecture
(4 docs)System Architecture Overview
ArchitectureHigh-level architecture diagram, microservices overview, data flow, and technology stack.
Database Design & Schema
ArchitectureEntity relationship diagrams, table schemas, indexing strategy, and graph model for Neo4j.
API Gateway Design
ArchitectureRate limiting, authentication flow, routing rules, and request/response transformation.
Indoor Navigation Algorithm
ArchitectureA* pathfinding on graph model, floor transitions, accessibility routing, and optimization.
API Guidelines
(3 docs)REST API Conventions
API GuidelinesNaming conventions, HTTP methods, status codes, pagination, filtering, and error responses.
Authentication & Authorization
API GuidelinesJWT token flow, refresh tokens, role-based access control, and LDAP integration.
API Versioning Strategy
API GuidelinesURL versioning approach, deprecation policy, breaking changes, and migration guides.
Security
(3 docs)Security Best Practices
SecurityInput validation, SQL injection prevention, XSS protection, CORS configuration.
Data Privacy & POPIA Compliance
SecurityStudent data handling, consent management, data retention, and right to erasure.
Incident Response Plan
SecuritySeverity levels, escalation procedures, communication templates, and post-mortem process.
Deployment
(4 docs)CI/CD Pipeline Guide
DeploymentGitHub Actions workflow, build stages, automated testing, and deployment to Kubernetes.
Kubernetes Configuration
DeploymentPod specs, services, ingress rules, secrets management, and horizontal pod autoscaling.
Environment Setup Guide
DeploymentLocal development setup, Docker Compose, environment variables, and test data seeding.
Rollback Procedures
DeploymentAutomated rollback triggers, manual rollback steps, database migration reversal.
Troubleshooting
(3 docs)Common Issues & Solutions
TroubleshootingFAQ for development issues: database connections, auth failures, map rendering, sensor data.
Performance Optimization Guide
TroubleshootingQuery optimization, caching strategies, connection pooling, and bundle size reduction.
Monitoring & Alerting Setup
TroubleshootingPrometheus metrics, Grafana dashboards, alert rules, and PagerDuty integration.