Docs Library

DA

Documentation Library

Technical guides, architecture docs, and reference materials.

Architecture

(4 docs)

System Architecture Overview

Architecture

High-level architecture diagram, microservices overview, data flow, and technology stack.

Updated Mar 20, 2026 DA

Database Design & Schema

Architecture

Entity relationship diagrams, table schemas, indexing strategy, and graph model for Neo4j.

Updated Mar 18, 2026 DA

API Gateway Design

Architecture

Rate limiting, authentication flow, routing rules, and request/response transformation.

Updated Mar 15, 2026 DevOps Engineer

Indoor Navigation Algorithm

Architecture

A* pathfinding on graph model, floor transitions, accessibility routing, and optimization.

Updated Mar 12, 2026 DA

API Guidelines

(3 docs)

REST API Conventions

API Guidelines

Naming conventions, HTTP methods, status codes, pagination, filtering, and error responses.

Updated Mar 22, 2026 DA

Authentication & Authorization

API Guidelines

JWT token flow, refresh tokens, role-based access control, and LDAP integration.

Updated Mar 21, 2026 DA

API Versioning Strategy

API Guidelines

URL versioning approach, deprecation policy, breaking changes, and migration guides.

Updated Mar 10, 2026 DA

Security

(3 docs)

Security Best Practices

Security

Input validation, SQL injection prevention, XSS protection, CORS configuration.

Updated Mar 19, 2026 DevOps Engineer

Data Privacy & POPIA Compliance

Security

Student data handling, consent management, data retention, and right to erasure.

Updated Mar 16, 2026 DA

Incident Response Plan

Security

Severity levels, escalation procedures, communication templates, and post-mortem process.

Updated Mar 14, 2026 DevOps Engineer

Deployment

(4 docs)

CI/CD Pipeline Guide

Deployment

GitHub Actions workflow, build stages, automated testing, and deployment to Kubernetes.

Updated Mar 23, 2026 DevOps Engineer

Kubernetes Configuration

Deployment

Pod specs, services, ingress rules, secrets management, and horizontal pod autoscaling.

Updated Mar 20, 2026 DevOps Engineer

Environment Setup Guide

Deployment

Local development setup, Docker Compose, environment variables, and test data seeding.

Updated Mar 17, 2026 DA

Rollback Procedures

Deployment

Automated rollback triggers, manual rollback steps, database migration reversal.

Updated Mar 13, 2026 DevOps Engineer

Troubleshooting

(3 docs)

Common Issues & Solutions

Troubleshooting

FAQ for development issues: database connections, auth failures, map rendering, sensor data.

Updated Mar 24, 2026 DA

Performance Optimization Guide

Troubleshooting

Query optimization, caching strategies, connection pooling, and bundle size reduction.

Updated Mar 18, 2026 DA

Monitoring & Alerting Setup

Troubleshooting

Prometheus metrics, Grafana dashboards, alert rules, and PagerDuty integration.

Updated Mar 15, 2026 DevOps Engineer