nexusguard/Nexus-Guard-Suite
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 6 Wiki Activity

docs: update AGENTS.md

Browse Source
This commit is contained in:
datadunia
2026-07-07 17:22:28 +07:00
parent 5d3761c56c
commit 8cadfc4657
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+13
View File
@@ -38,6 +38,19 @@ NexusGuard SD-WAN Suite: Enterprise Zero-Trust SD-WAN with WireGuard tunneling,
**CRITICAL**: `apps/*` are **git submodules** — clone with `--recurse-submodules`. **CRITICAL**: `apps/*` are **git submodules** — clone with `--recurse-submodules`.
## SUBMODULE KNOWLEDGE BASES
Each submodule has its own `AGENTS.md` with detailed architecture, conventions, and anti-patterns:
| Submodule | AGENTS.md | Scope |
|-----------|-----------|-------|
| Server Core | `apps/server-core/AGENTS.md` | API handlers, database models, firewall rules, gRPC signaling, WireGuard management |
| Dashboard UI | `apps/dashboard-ui/AGENTS.md` | Vue 3 components, Pinia stores, TailwindCSS styling, API client |
| Device Agent | `apps/device-agent/AGENTS.md` | Go daemon, system tray, memory-injected WireGuard, heartbeat, gRPC signaling |
| Android Agent | `apps/android-agent/AGENTS.md` | Kotlin VPNService, GoBackend tunnel, HTTP heartbeat, port forwarding, boot auto-start |
**Rule**: When working on a submodule, ALWAYS read its `AGENTS.md` first for project-specific conventions.
## WHERE TO LOOK ## WHERE TO LOOK
| Task | Location | Notes | | Task | Location | Notes |
|------|----------|-------| |------|----------|-------|