diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c12427c3a..edb78e823 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,7 @@ installer tooling. - **Backend (`cmd/`, `internal/`, `pkg/`)** – Go 1.23+ web server that embeds the built frontend and exposes REST + WebSocket APIs. +- **Architecture (`ARCHITECTURE.md`)** – High-level system design diagrams and explanations. - **Frontend (`frontend-modern/`)** – Vite + React app built with TypeScript. - **Agents (`cmd/pulse-*-agent`)** – Go binaries distributed alongside Pulse for host and Docker telemetry. diff --git a/README.md b/README.md index fed2caa35..67ac27e83 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,7 @@ Access the dashboard at `http://:7655`. - **[Configuration](docs/CONFIGURATION.md)**: Setup authentication, notifications, and advanced settings. - **[Security](SECURITY.md)**: Learn about Pulse's security model and best practices. - **[API Reference](docs/API.md)**: Integrate Pulse with your own tools. +- **[Architecture](ARCHITECTURE.md)**: High-level system design and data flow. - **[Troubleshooting](docs/TROUBLESHOOTING.md)**: Solutions to common issues. ## ❤️ Support Pulse Development diff --git a/docs/README.md b/docs/README.md index a82c0d37f..9a6045c03 100644 --- a/docs/README.md +++ b/docs/README.md @@ -38,6 +38,7 @@ Welcome to the Pulse documentation portal. Here you'll find everything you need - **[API Reference](API.md)** – Complete REST API documentation. - **[Dev Quick Start](../DEV-QUICK-START.md)** – Hot-reload workflow for contributors. +- **[Architecture](../ARCHITECTURE.md)** – System design and component interaction. - **[Contributing](../CONTRIBUTING.md)** – How to contribute to Pulse. - **[Mock Mode](development/MOCK_MODE.md)** – Developing without real infrastructure.