Sankofa/docs/infrastructure/USER_GUIDE.md

Infrastructure Documentation Dashboard - User Guide

Overview

The Infrastructure Documentation Dashboard provides a comprehensive interface for managing network topology, compliance requirements, deployment timelines, and cost estimates.

Getting Started

Navigation

• Dashboard: Overview of all infrastructure documentation
• Network Topology: Visualize and edit network diagrams
• Compliance Mapping: Track compliance by country and framework
• Deployment Timeline: Manage deployment milestones
• Cost Estimates: View and manage cost projections

Keyboard Shortcuts

• Ctrl/Cmd + E: Toggle edit mode
• Ctrl/Cmd + S: Save changes
• Ctrl/Cmd + /: Show keyboard shortcuts
• Ctrl/Cmd + F: Open global search
• Escape: Cancel/Exit current action

Features

Network Topology

Viewing Topology

• Select region and entity from dropdowns
• Use zoom controls to navigate large diagrams
• Click nodes to view details

Editing Topology

1. Enable edit mode using the toggle
2. Add Node: Click "Add Node" button
3. Move Node: Drag nodes to reposition
4. Connect Nodes: Click "Connect Nodes", then click source and target
5. Delete Node/Edge: Select and click delete
6. Undo/Redo: Use undo/redo buttons
7. Save: Click "Save Changes" when done

Exporting

• PNG: Export as high-resolution image
• SVG: Export as vector graphic

Compliance Mapping

Viewing Compliance

• Geographic map shows compliance status by country
• Table view provides detailed information
• Filter by region, search by country/framework

Editing Compliance

1. Enable edit mode
2. Click "Edit" on any requirement
3. Update frameworks, status, requirements
4. Save changes

Bulk Operations

1. Enable edit mode
2. Select items using checkboxes
3. Use bulk actions toolbar
4. Confirm deletion

Deployment Timeline

Viewing Timeline

• Gantt chart shows milestone schedule
• List view provides detailed information
• Filter by region, entity, status

Editing Milestones

1. Enable edit mode
2. Click "Add Milestone" or "Edit" on existing
3. Fill in details, dates, dependencies
4. Save changes

Drag and Drop

• In edit mode, drag milestones to reschedule
• Dates automatically update based on position
• Changes save automatically

Cost Estimates

Viewing Costs

• Charts show cost breakdown by region/category
• Table provides detailed estimates
• Forecast shows projected costs

Editing Costs

1. Enable edit mode
2. Click "Edit" on any estimate
3. Update monthly/annual costs
4. Breakdown auto-calculates

Advanced Features

Global Search

Press Ctrl/Cmd + F or click the search button to search across:

• Countries
• Topologies
• Compliance requirements
• Milestones
• Cost estimates

Advanced Filters

1. Click "Advanced Filters"
2. Select multiple values for multi-select filters
3. Set date ranges
4. Set cost ranges
5. Save as preset for reuse

Export Options

• Topology: PNG, SVG
• Timeline: PDF
• Costs: Excel (multi-sheet)
• Compliance: CSV (via audit log)

Backup and Restore

1. Navigate to settings
2. Click "Create Backup"
3. Backups are timestamped
4. Restore from backup list

Version History

1. Open any entity in edit mode
2. Click "Version History"
3. View all changes over time
4. Compare versions
5. Restore previous version

Audit Log

View all operations and changes:

• Filter by action type
• Filter by entity type
• Search by name/ID
• Export to CSV

Mobile Usage

• Sidebar collapses on mobile
• Touch-friendly controls
• Responsive tables and charts
• Swipe gestures for navigation

Accessibility

• Keyboard navigation throughout
• Screen reader support
• High contrast mode
• Focus indicators
• Skip links

Troubleshooting

Data Not Loading

• Check network connection
• Refresh the page
• Clear browser cache

Changes Not Saving

• Ensure edit mode is enabled
• Check for validation errors
• Verify network connection

Export Failing

• Ensure data is loaded
• Check browser permissions
• Try different export format

Support

For issues or questions, contact the infrastructure team.