Skip to content

docs(readme): streamline documentation and refresh dashboard screenshots - #68

Merged
simonvanlierde merged 2 commits into
mainfrom
docs/streamline-and-refresh-screenshots
Nov 1, 2026
Merged

simonvanlierde merged 2 commits into
mainfrom
docs/streamline-and-refresh-screenshots

Conversation

@simonvanlierde

Copy link
Copy Markdown
Contributor

This restructures the documentation around researcher onboarding, extracts host operator details into the runbook and updates dashboard

  • Trimmed README.md down to 98 lines, prioritizing quickstart onboarding, the active CML reporting table, and hub-and-spoke architecture.
  • Extracted production pre-flight guards, Cloudflare Access setup, and S3 storage migration into `docs/RUNBOOK.md
  • Added a 4-row recipe selector to docs/ONBOARDING.md and applied Simplified Technical English `templates/web/README.md
  • Refreshed docs/img/service-health.png and docs/img/stack-health.png from the live demo stack via Chrome to display the new unified navbar and headline KPI

Tests: just check passed (yamllint, actionlint, shellcheck, ruff, yamlfmt, tofu, jq, promtool, alloy, gitleaks), and just demo verified live metrics rendering.

- Focus README on researcher onboarding, live adoption table, and architecture
- Extract operator environment guards and storage migration into docs/RUNBOOK.md
- Add 4-row recipe selector and simplified copy-paste snippets to docs/ONBOARDING.md
- Refresh docs/img/service-health.png and docs/img/stack-health.png from live demo stack
- Tighten templates/web/README.md with active voice and concise security guidelines
@simonvanlierde
simonvanlierde merged commit 0f07b0e into main Nov 1, 2026
4 checks passed
@simonvanlierde
simonvanlierde deleted the docs/streamline-and-refresh-screenshots branch November 1, 2026 03:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant