|
1 | 1 | # SentraCore Documentation |
2 | 2 |
|
3 | | -This directory contains the technical documentation for the SentraCore project, including setup guides, architecture references, development workflows, and packaging instructions. |
| 3 | +Central documentation hub for **SentraCore** — a local system behavior intelligence platform designed to transform system telemetry into explainable operational insights through analytics, prediction, and real-time observability. |
4 | 4 |
|
5 | | -For a high-level product overview and feature list, start with the [repository README](../README.md). |
| 5 | +This documentation provides architecture references, setup instructions, development workflows, and deployment guidance for contributors, maintainers, and advanced users. |
| 6 | + |
| 7 | +For product overview, capabilities, and repository onboarding, begin with the [main repository README](../README.md). |
| 8 | + |
| 9 | +--- |
| 10 | + |
| 11 | +## Documentation Overview |
| 12 | + |
| 13 | +This directory contains technical resources for understanding, building, extending, and operating SentraCore. |
| 14 | + |
| 15 | +### Contents |
| 16 | + |
| 17 | +- Development and environment setup |
| 18 | +- Engine runtime configuration |
| 19 | +- Dashboard build instructions |
| 20 | +- Architecture references |
| 21 | +- Intelligence pipeline internals |
| 22 | +- Persistence and storage behavior |
| 23 | +- Packaging and release workflows |
6 | 24 |
|
7 | 25 | --- |
8 | 26 |
|
9 | | -# Repository map |
| 27 | +## Repository Structure |
| 28 | + |
| 29 | +The SentraCore repository is organized into modular system boundaries. |
10 | 30 |
|
11 | | -| Path | Purpose | |
| 31 | +| Path | Responsibility | |
12 | 32 | |---|---| |
13 | | -| `engine/` | Python telemetry service, intelligence pipeline, and local API | |
14 | | -| `dashboard/` | Flutter desktop client | |
15 | | -| `docs/` | Setup and architecture documentation (this tree) | |
16 | | -| `installer/` | Windows installer definitions (Inno Setup) | |
17 | | -| `pages/` | Static marketing and docs HTML (GitHub Pages) | |
18 | | -| `assets/` | Shared site styles, scripts, and images for `pages/` | |
19 | | -| `tests/` | Engine and API unit tests | |
| 33 | +| `engine/` | Telemetry engine, intelligence processing, runtime services, and local API | |
| 34 | +| `dashboard/` | Flutter desktop application and user interface | |
| 35 | +| `docs/` | Technical documentation and implementation references | |
| 36 | +| `installer/` | Windows packaging and installation definitions | |
| 37 | +| `pages/` | Static website and public documentation | |
| 38 | +| `assets/` | Shared frontend assets used across documentation pages | |
| 39 | +| `tests/` | Automated testing for engine and API components | |
20 | 40 |
|
21 | 41 | --- |
22 | 42 |
|
23 | | -# Setup Guides |
| 43 | +## Setup Guides |
| 44 | + |
| 45 | +Use these guides to configure a local development environment. |
24 | 46 |
|
25 | 47 | | Guide | Description | |
26 | 48 | |---|---| |
27 | | -| [Development Setup](setup/development_setup.md) | Complete multi-platform development environment setup | |
28 | | -| [Engine Setup](setup/engine_setup.md) | Python engine installation and runtime guide | |
29 | | -| [Dashboard Setup](setup/dashboard_setup.md) | Flutter desktop dashboard setup and build guide | |
| 49 | +| [Development Setup](setup/development_setup.md) | Complete environment setup for local development | |
| 50 | +| [Engine Setup](setup/engine_setup.md) | Engine installation, configuration, and execution | |
| 51 | +| [Dashboard Setup](setup/dashboard_setup.md) | Flutter dashboard development and build workflow | |
30 | 52 |
|
31 | 53 | --- |
32 | 54 |
|
33 | | -# Architecture & Technical Reference |
| 55 | +## Architecture & Technical Reference |
| 56 | + |
| 57 | +Detailed implementation references for internal platform components. |
34 | 58 |
|
35 | 59 | | Document | Description | |
36 | 60 | |---|---| |
37 | | -| [Intelligence Pipeline](architecture/intelligence_layer.md) | Detailed overview of the telemetry intelligence pipeline | |
38 | | -| [Persistence Layout](architecture/persistence.md) | Where the engine keeps preferences, baseline, history, and logs | |
39 | | -| [Hardware Health](architecture/hardware_health.md) | CPU / RAM / disk SMART probes and the overall status taxonomy | |
40 | | -| [Storage Scanning & Cleanup](architecture/storage_scan.md) | Disk cleanup categories, scan-id safety model, large file finder | |
41 | | -| [Building SentraCore](architecture/building.md) | Desktop build, packaging, and release workflow | |
| 61 | +| [Intelligence Pipeline](architecture/intelligence_layer.md) | Telemetry ingestion, analysis, prediction, and insight generation | |
| 62 | +| [Persistence Architecture](architecture/persistence.md) | Storage layout for preferences, baselines, logs, and history | |
| 63 | +| [Hardware Health Monitoring](architecture/hardware_health.md) | CPU, memory, SMART monitoring, and health classification | |
| 64 | +| [Storage Analysis & Cleanup](architecture/storage_scan.md) | Storage scanning, cleanup rules, and scan safety mechanisms | |
| 65 | +| [Build & Packaging](architecture/building.md) | Desktop packaging, installer generation, and release workflow | |
42 | 66 |
|
43 | 67 | --- |
44 | 68 |
|
45 | | -# Project Overview |
| 69 | +## Project Overview |
46 | 70 |
|
47 | | -SentraCore is a local system behavior intelligence platform that transforms raw system telemetry into explainable performance insights through: |
| 71 | +SentraCore is an **intelligence-driven desktop observability platform** that converts raw telemetry into actionable system understanding. |
48 | 72 |
|
49 | | -- behavioral modeling |
50 | | -- anomaly detection |
51 | | -- predictive risk analysis |
52 | | -- root cause correlation |
53 | | -- real-time monitoring |
54 | | -- historical system analysis |
| 73 | +Core platform capabilities include: |
55 | 74 |
|
56 | | -The project is structured around a modular engine and desktop dashboard architecture. |
| 75 | +- Behavioral modeling |
| 76 | +- Performance intelligence |
| 77 | +- Real-time monitoring |
| 78 | +- Anomaly detection |
| 79 | +- Predictive risk analysis |
| 80 | +- Root cause correlation |
| 81 | +- Historical trend analysis |
| 82 | + |
| 83 | +The platform follows a **modular engine + dashboard architecture** to separate intelligence processing from user interaction. |
57 | 84 |
|
58 | 85 | --- |
59 | 86 |
|
60 | | -# Core Components |
| 87 | +## System Components |
61 | 88 |
|
62 | 89 | | Component | Description | |
63 | 90 | |---|---| |
64 | | -| Engine | Python-based telemetry and intelligence service | |
65 | | -| Dashboard | Flutter desktop application | |
| 91 | +| Engine | Python runtime responsible for telemetry and intelligence | |
| 92 | +| Dashboard | Flutter-based desktop interface | |
66 | 93 | | API Layer | Local REST and WebSocket communication | |
67 | | -| Intelligence Pipeline | Trend, anomaly, prediction, and correlation systems | |
68 | | -| Packaging System | Desktop build and installer workflow | |
| 94 | +| Intelligence Layer | Detection, prediction, and correlation engine | |
| 95 | +| Packaging Layer | Build and installer workflow | |
69 | 96 |
|
70 | 97 | --- |
71 | 98 |
|
72 | | -# Platform Support |
| 99 | +## Supported Platforms |
73 | 100 |
|
74 | | -| Platform | Status | |
| 101 | +| Platform | Support Level | |
75 | 102 | |---|---| |
76 | | -| Windows | Primary Support | |
| 103 | +| Windows | Full Support | |
77 | 104 | | Linux | Development Support | |
78 | 105 | | macOS | Development Support | |
79 | 106 |
|
80 | | -Windows currently provides the most complete packaging and deployment workflow. |
| 107 | +> Windows currently provides the most complete installation and packaging experience. |
81 | 108 |
|
82 | 109 | --- |
83 | 110 |
|
84 | | -# Development Scope |
| 111 | +## Development Scope |
85 | 112 |
|
86 | | -The project currently includes: |
| 113 | +Current platform capabilities include: |
87 | 114 |
|
88 | | -- real-time telemetry collection |
89 | | -- adaptive baseline learning |
90 | | -- anomaly detection |
91 | | -- predictive degradation analysis |
92 | | -- root cause analysis |
93 | | -- historical monitoring |
94 | | -- desktop notifications |
95 | | -- dashboard diagnostics |
96 | | -- desktop packaging workflow |
| 115 | +- Real-time telemetry collection |
| 116 | +- Adaptive baseline learning |
| 117 | +- Behavioral analysis |
| 118 | +- Anomaly detection |
| 119 | +- Predictive degradation analysis |
| 120 | +- Root cause investigation |
| 121 | +- Historical system monitoring |
| 122 | +- Desktop notifications |
| 123 | +- Diagnostic dashboards |
| 124 | +- Desktop packaging workflow |
97 | 125 |
|
98 | 126 | --- |
99 | 127 |
|
100 | | -# Documentation Structure |
| 128 | +## Documentation Layout |
101 | 129 |
|
102 | 130 | ```text |
103 | 131 | docs/ |
| 132 | +│ |
104 | 133 | ├── setup/ |
105 | 134 | │ ├── development_setup.md |
106 | 135 | │ ├── engine_setup.md |
107 | 136 | │ └── dashboard_setup.md |
108 | 137 | │ |
109 | 138 | ├── architecture/ |
110 | 139 | │ ├── intelligence_layer.md |
| 140 | +│ ├── persistence.md |
| 141 | +│ ├── hardware_health.md |
| 142 | +│ ├── storage_scan.md |
111 | 143 | │ └── building.md |
| 144 | +│ |
| 145 | +└── README.md |
112 | 146 | ``` |
113 | 147 |
|
114 | 148 | --- |
115 | 149 |
|
116 | | -# Notes |
| 150 | +## Typical Development Workflow |
| 151 | + |
| 152 | +### 1. Prepare Environment |
| 153 | + |
| 154 | +Create and activate a Python virtual environment. |
117 | 155 |
|
118 | | -- The documentation is designed for contributors, developers, and advanced users. |
119 | | -- Platform-specific behavior may vary depending on operating system capabilities. |
120 | | -- Additional documentation may be expanded as the project evolves. |
| 156 | +Install engine dependencies. |
| 157 | + |
| 158 | +See: |
| 159 | + |
| 160 | +```text |
| 161 | +setup/development_setup.md |
| 162 | +``` |
| 163 | + |
| 164 | +--- |
| 165 | + |
| 166 | +### 2. Start Engine |
| 167 | + |
| 168 | +Launch the telemetry engine. |
| 169 | + |
| 170 | +```bash |
| 171 | +python -m engine.main |
| 172 | +``` |
| 173 | + |
| 174 | +Or use the documented project entrypoint. |
121 | 175 |
|
122 | 176 | --- |
123 | 177 |
|
124 | | -# Typical development loop |
| 178 | +### 3. Launch Dashboard |
| 179 | + |
| 180 | +Open a second terminal. |
| 181 | + |
| 182 | +Run the Flutter dashboard against the local engine. |
| 183 | + |
| 184 | +See: |
| 185 | + |
| 186 | +```text |
| 187 | +setup/dashboard_setup.md |
| 188 | +``` |
| 189 | + |
| 190 | +--- |
| 191 | + |
| 192 | +### 4. Run Validation |
| 193 | + |
| 194 | +Execute automated tests before committing changes. |
| 195 | + |
| 196 | +```bash |
| 197 | +pytest |
| 198 | +``` |
| 199 | + |
| 200 | +--- |
| 201 | + |
| 202 | +## Contributing Notes |
| 203 | + |
| 204 | +Before opening pull requests: |
| 205 | + |
| 206 | +- Follow documented setup procedures |
| 207 | +- Validate local builds |
| 208 | +- Run test suites |
| 209 | +- Keep architecture documentation updated |
| 210 | +- Maintain cross-platform compatibility where applicable |
| 211 | + |
| 212 | +--- |
| 213 | + |
| 214 | +## Documentation Principles |
| 215 | + |
| 216 | +SentraCore documentation is designed around: |
| 217 | + |
| 218 | +- Developer onboarding |
| 219 | +- Maintainable architecture |
| 220 | +- Operational clarity |
| 221 | +- Reproducible workflows |
| 222 | +- Long-term maintainability |
| 223 | + |
| 224 | +--- |
| 225 | + |
| 226 | +## Additional Notes |
| 227 | + |
| 228 | +- Platform behavior may vary across operating systems |
| 229 | +- Documentation evolves alongside implementation |
| 230 | +- Architecture documents are considered the source of technical truth |
| 231 | + |
| 232 | +--- |
| 233 | + |
| 234 | +<div align="center"> |
| 235 | + |
| 236 | +### SentraCore Documentation |
| 237 | + |
| 238 | +Build • Understand • Extend |
125 | 239 |
|
126 | | -1. Create or activate a Python virtual environment and install engine dependencies (see [Development Setup](setup/development_setup.md)). |
127 | | -2. Run the engine from the repo root (for example `python -m engine.main` or your documented entrypoint). |
128 | | -3. In another terminal, run the Flutter dashboard against the local engine (see [Dashboard Setup](setup/dashboard_setup.md)). |
129 | | -4. Run `pytest` from the repo root before pushing changes that touch the engine or tests. |
| 240 | +</div> |
0 commit comments