mirror of
https://github.com/rcourtman/Pulse.git
synced 2026-02-18 00:17:39 +01:00
Link ARCHITECTURE.md in documentation
This commit is contained in:
@@ -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.
|
||||
|
||||
@@ -58,6 +58,7 @@ Access the dashboard at `http://<your-ip>: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
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user