Skip to content

Commit 308449f

Browse files
VijitSingh97claude
andauthored
docs: fix three small accuracy issues (#554) (#568)
- docs/monitoring.md:199 documented a nonexistent './pithead stop'; the real command is 'down' (pithead:5455). Confirmed no other doc references 'pithead stop'. - docs/releasing.md:34 hardcoded a stale VERSION example ('1.0.3'); reword so it can't go stale again. - docker-compose.yml:512 comment called the dashboard a "Flask" app; it's aiohttp (build/dashboard/mining_dashboard/web/server.py, build/dashboard/pyproject.toml). Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent 94b451b commit 308449f

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -509,7 +509,7 @@ services:
509509
PITHEAD_GIT_BRANCH: ${PITHEAD_GIT_BRANCH:-}
510510
PITHEAD_RELEASE: ${PITHEAD_RELEASE:-}
511511
container_name: dashboard
512-
# Memory ceiling (#132 — see monerod). A small Flask + SQLite app (~0.06 GiB observed); a tight
512+
# Memory ceiling (#132 — see monerod). A small aiohttp + SQLite app (~0.06 GiB observed); a tight
513513
# cap is pure upside — a memory regression OOM-restarts the dashboard, not the revenue services.
514514
mem_limit: 512m
515515
memswap_limit: 512m

docs/monitoring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Use a **separate** check for the host timer if you want to tell "the host is up"
196196
enabled` line at startup — if it's absent, no ping URL is configured. The ping is always over
197197
Tor, so a URL your Tor exit can't reach (e.g. a LAN-only self-hosted instance) will never land;
198198
ping failures themselves are logged at debug level only.
199-
- **Test it end to end.** Stop the stack (`./pithead stop`) and wait for the period + grace to
199+
- **Test it end to end.** Stop the stack (`./pithead down`) and wait for the period + grace to
200200
elapse — you should get the alert. Start it again and the check recovers.
201201
- **Too many false alarms.** Increase the **period** and/or **grace** on Healthchecks.io.
202202

docs/releasing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ The product version lives in a top-level [`VERSION`](../VERSION) file: plain tex
3131
- The dashboard's `pyproject.toml` is kept in lockstep (packaging metadata only); a shell test fails
3232
if it drifts from `VERSION`.
3333

34-
> NOTE: `VERSION` is `1.0.3`. Set it to the version you want to publish; the `pyproject.toml`
35-
> metadata must match, enforced by the drift-guard test.
34+
> NOTE: `VERSION` holds the last released version. Set it to the version you want to publish; the
35+
> `pyproject.toml` metadata must match, enforced by the drift-guard test.
3636
3737
## Component pins = an ingredients manifest
3838

0 commit comments

Comments
 (0)