Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
207 changes: 116 additions & 91 deletions README.md

Large diffs are not rendered by default.

188 changes: 118 additions & 70 deletions README.zh-CN.md

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# NetGuardian documentation

| Start here | Documentation |
| --- | --- |
| Project and quick start | [English README](../README.md) · [简体中文 README](../README.zh-CN.md) |
| Portfolio demo | [Walkthrough and screenshot gallery](product/DEMO_GUIDE.md) · [Hospitality workspace and data semantics](product/HOSPITALITY_OPERATIONS.md) |
| Deployment and operations | [Local setup, environment and Agent enrollment](operations/LOCAL_DEVELOPMENT.md) · [Runbook](operations/RUNBOOK.md) |
| Architecture | [System design](architecture/SYSTEM_DESIGN.md) · [Data model](architecture/DATA_MODEL.md) |
| Security | [Threat model](security/THREAT_MODEL.md) · [License and third-party assets](../NOTICE.md) |
| Verification | [Acceptance matrix](product/ACCEPTANCE_MATRIX.md) · [Verification](product/VERIFICATION.md) · [Browser QA](product/BROWSER_QA.md) · [Windows delivery](product/WINDOWS_DELIVERY.md) |
| Planning | [PRD](product/PRD.md) · [Implementation plan](product/IMPLEMENTATION_PLAN.md) · [Delivery status](product/DELIVERY_STATUS.md) |
Binary file added docs/assets/screenshots/hotel-dashboard.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/screenshots/hotel-diagnostics.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/screenshots/hotel-mobile.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/screenshots/hotel-topology.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/screenshots/test-evidence-report.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/screenshots/test-workspace.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs/product/DEMO_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Hospitality demo walkthrough

Use the [frontend quick start](../../README.md#demo-quick-start) and open the
local home page. Aster Quay Hotel is fictional, and the page marks its
observations as **DEMO / SIMULATED**. The fixture never connects to the control
API or dispatches jobs.

1. In **Overview**, inspect an endpoint trend bar to see its recorded status.
A gap means no data. An HTTP 503 is an observed response.
2. In **Services**, compare the POS probe outcome, HTTP endpoint health and
collection freshness. A HEAD result cannot measure an entire POS transaction.
3. In **Topology**, select **POS terminals** to view the simulated incident link.
Edges represent configured logical links.
4. Open **Incidents**, then **Inspect evidence**. The troubleshooting view shows
observed DNS, TCP, TLS and HTTP layers, possible explanations, suggested
checks, and raw simulated evidence.

## Screenshot gallery

The first four images were captured from the running frontend with the demo
fixture. The last two come from the authenticated frontend with a disposable
SQLite database from the loopback HTTPS integration test. The database
contains test-only records for `netguardian.test`. The report reflects actual
test fixture responses (HTTP 503 and 204). All captures exclude credentials
and hotel operational data.

| Capture | Environment |
| --- | --- |
| [Dashboard and Business Service Health](../assets/screenshots/hotel-dashboard.jpg) | Simulated demo, desktop |
| [Topology and incident timeline](../assets/screenshots/hotel-topology.jpg) | Simulated demo, desktop |
| [POS troubleshooting](../assets/screenshots/hotel-diagnostics.jpg) | Simulated demo, desktop |
| [Mobile overview](../assets/screenshots/hotel-mobile.jpg) | Simulated demo, dark theme |
| [Authenticated engineer workspace](../assets/screenshots/test-workspace.jpg) | Local HTTPS test records |
| [Evidence report](../assets/screenshots/test-evidence-report.jpg) | Local HTTPS test records, verified snapshot checksum |

The workspace requires the [full local services](../operations/LOCAL_DEVELOPMENT.md).
Generate a separate local token, start with no allowed origins, and access
`/workspace`. The empty state is expected for a new workspace.
Loading