Skip to content

Commit 58695a6

Browse files
feat: add screenshots and workflow from local fleet manager deployment (#140)
Signed-off-by: Patrick Stephens <pat@telemetryforge.io>
1 parent eb27356 commit 58695a6

12 files changed

Lines changed: 99 additions & 73 deletions

AGENTS.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,22 @@ Canonical packaging flow:
6060
./scripts/local-serve.sh
6161
```
6262

63+
## Fleet Manager Docs Workflow
64+
65+
When updating pages under `docs/fleet-manager/`, use this workflow unless the task explicitly requests otherwise.
66+
67+
- Treat `https://manager.telemetryforge.io` as the default endpoint for user-facing instructions, links, and login screenshots.
68+
- Use the production login experience (for example, GitHub/Google providers), not local dev-mode login.
69+
- Avoid `http://localhost:4444` references in published docs unless a task explicitly asks for local-only instructions.
70+
- If you need local UI validation/screenshot capture, the manager stack can be started from this repository with:
71+
72+
```bash
73+
docker compose -f ../manager/compose.yaml up -d
74+
```
75+
76+
- Reuse a still-running local stack when available; do not restart it unnecessarily.
77+
- For GraphQL `createAgent` examples, use a valid `config` payload (JSON object string) that maps to the getting-started pipeline in `docs/agent/getting-started.md`.
78+
6379
## Navigation Warning Handling
6480

6581
MkDocs omitted-from-nav suppression should use `not_in_nav` in `mkdocs.yml` with .gitignore-style glob patterns (not regex).
168 KB
Loading
112 KB
Loading
102 KB
Loading
96.7 KB
Loading
114 KB
Loading
110 KB
Loading
69.6 KB
Loading
45.9 KB
Loading
77.9 KB
Loading

0 commit comments

Comments
 (0)