fix(web): make public /docs user-facing, drop internal dev runbooks (BUNYIP-387) #381

Merged

nrupard merged 2 commits from fix/BUNYIP-387-user-facing-docs into main

2026-07-21 15:45:26 +02:00

nrupard commented

2026-07-21 15:13:02 +02:00

Owner

Problem

Public /docs (BUNYIP-385) served the repo's internal developer runbooks to end users. Every embedded doc was dev/internal: the e2e suite guide, a sqlx-checksum reconcile procedure, a dev-sso runbook that names internal hosts and infra, a client-IP-forwarding note, a Stripe test-mode guide, an OCI verification runbook, and a getting-started page whose first line was "the developer fast path: clone, run". /docs is public and linked from the marketing nav, so users who came to download an app like Mokosh were shown internal runbooks instead of product docs.

Change

Curate /docs to user-facing product docs (BUNYIP-387):

Remove all 7 dev docs from the DOCS registry in content.rs and delete their crate-local copies under bunyip-web/src/docs/. The canonical copies stay under the repo docs/ and docs/dev-docs/ for developers; the one admin-facing reference to docs/stripe-test-mode.md still resolves against that path.
Add 3 user docs, grounded in the real member flow (the /applications and /membership routes, the OciImage docker login + docker pull coordinates, and binary release assets): getting-started (what Bunyip is, sign in, find apps on the Applications page), downloading-apps (pull the container image, or download the release binary for your platform, then run it), and membership (when an app needs an active membership and how to start one).
The render pipeline, the raw-HTML strip, and the slug-agnostic docs_tests are unchanged.

Verification

Build + clippy + fmt green (SQLX_OFFLINE, pinned rust-builder); all 107 bunyip-web tests pass including docs_registry_is_sound. No dev doc is reachable under /docs, and no dangling include_str! or internal /docs link remains. Net effect removes roughly 1.7k lines of internal documentation from the public surface.

## Problem Public `/docs` (BUNYIP-385) served the repo's internal developer runbooks to end users. Every embedded doc was dev/internal: the e2e suite guide, a sqlx-checksum reconcile procedure, a dev-sso runbook that names internal hosts and infra, a client-IP-forwarding note, a Stripe test-mode guide, an OCI verification runbook, and a getting-started page whose first line was "the developer fast path: clone, run". `/docs` is public and linked from the marketing nav, so users who came to download an app like Mokosh were shown internal runbooks instead of product docs. ## Change Curate `/docs` to user-facing product docs (BUNYIP-387): - Remove all 7 dev docs from the `DOCS` registry in `content.rs` and delete their crate-local copies under `bunyip-web/src/docs/`. The canonical copies stay under the repo `docs/` and `docs/dev-docs/` for developers; the one admin-facing reference to `docs/stripe-test-mode.md` still resolves against that path. - Add 3 user docs, grounded in the real member flow (the `/applications` and `/membership` routes, the `OciImage` `docker login` + `docker pull` coordinates, and binary release assets): **getting-started** (what Bunyip is, sign in, find apps on the Applications page), **downloading-apps** (pull the container image, or download the release binary for your platform, then run it), and **membership** (when an app needs an active membership and how to start one). - The render pipeline, the raw-HTML strip, and the slug-agnostic `docs_tests` are unchanged. ## Verification Build + clippy + fmt green (SQLX_OFFLINE, pinned rust-builder); all 107 bunyip-web tests pass including `docs_registry_is_sound`. No dev doc is reachable under `/docs`, and no dangling `include_str!` or internal `/docs` link remains. Net effect removes roughly 1.7k lines of internal documentation from the public surface.

nrupard added 1 commit

2026-07-21 15:13:02 +02:00

fix(web): make public /docs user-facing, drop internal dev runbooks

E2E / Playwright against deployment (pull_request) Successful in 41s

Details

Check / fmt + clippy + build + tests (pull_request) Has been cancelled

Details

515d03b896

BUNYIP-385 stood /docs up as a temporary public home for the repo's top-level docs, but every embedded doc was developer or internal: an e2e-suite guide, a sqlx-checksum reconcile procedure, a dev-sso runbook that names internal hosts and infra, a client-IP-forwarding note, a Stripe test-mode guide, an OCI verification runbook, and a getting-started page whose first line was "the developer fast path: clone, run". /docs is public and linked from the marketing nav, so users who came to download an app like Mokosh were shown internal runbooks instead.

This curates /docs down to user-facing product docs. All 7 dev docs are removed from the DOCS registry in content.rs and their crate-local copies under bunyip-web/src/docs/ are deleted; the canonical copies stay under the repo docs/ and docs/dev-docs/ for developers, and the one admin-facing reference to docs/stripe-test-mode.md still resolves against that canonical path.

Three user docs replace them, grounded in the real member flow (the /applications and /membership routes, the OciImage docker login + docker pull coordinates, and binary release assets): getting-started (what Bunyip is, sign in, find apps on the Applications page), downloading-apps (pull the container image with docker login/docker pull, or download the release binary for your platform, then run it), and membership (when an app needs an active membership and how to start one).

The render pipeline, the raw-HTML strip, and the slug-agnostic docs_tests are unchanged. Net effect removes roughly 1.7k lines of internal documentation from the public surface. Verified green on build + clippy + fmt (SQLX_OFFLINE, pinned rust-builder) and all 107 bunyip-web tests including docs_registry_is_sound.

#BUNYIP-387

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

nrupard added 1 commit

2026-07-21 15:33:33 +02:00

fix(web): describe the account action instead of naming a button (BUNYIP-387)

E2E / Playwright against deployment (pull_request) Successful in 41s

Details

Check / fmt + clippy + build + tests (pull_request) Successful in 10m49s

Details

Create release / Create release from merged PR (pull_request) Has been skipped

Details

6c09fc7d6d

The getting-started doc bolded "Sign up" / "Sign in", but those labels vary across the app - the nav uses "Get Started" / "Login" / "Register" while the auth pages use "Sign up" / "Create account" / "Sign in". Describe the action instead so the copy does not drift from whichever button a user actually sees. Review follow-up.

#BUNYIP-387

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>