feat(docs): the-lab.md runbook + Hub & dashboard promotion#62
Merged
Conversation
Add a single end-to-end runbook (`docs/the-lab.md`, ~600 lines, ~12 min read) that's both a tour and an operational manual: what ARAIL is, why it matters, the two tiers, setup in five minutes, all five surfaces with "magic moment" callouts, Buddy, the Compute Source pivot, blueprint mentality, and three guided next-step reading paths. The doc covers a gap the prior Docs Hub work didn't fill — the Hub organized 24 docs but offered no single read-through that ties them together. The runbook is the on-ramp the user wants featured on the Hub and prepped for publishing to qukaizen.com/docs. Promotion: - src/arail/portal/app.py: prepend "the-lab" to _FEATURED_SLUGS — the runbook becomes the #1 featured card on /docs (replacing api-conventions; api-conventions stays in Reference for those who want it). New featured trio mirrors the user journey: tour → agent concepts → meet Buddy. - src/arail/portal/templates/docs_hub.html: hero copy now invites visitors to start with the runbook, linked inline. - src/arail/portal/templates/dashboard.html: first-run runbook banner above the existing updates banner. Blue accent (distinct from amber). Click → /docs/the-lab.md. Dismiss × persists in localStorage.arailRunbookDismissed so returning users aren't nagged. Cross-links inbound (so deep-landers find the runbook): - README.md: "See also" note above Quick start. - docs/INSTALL.md, docs/agents-explained.md, docs/BUDDY.md: blockquote link to the runbook just below each H1. Frontmatter: title "The lab, end-to-end", category Getting Started, order=0 (ranks ahead of INSTALL.md's order=1), audience beginner, read_minutes 12, buddy_prompt seeded for the "Ask Buddy about this doc" button. Tests (5 new, 116 total green): - tests/test_docs_registry.py: test_the_lab_in_registry — slug present, category Getting Started, order=0, first in category. - tests/test_docs_routes.py: - test_the_lab_runbook_renders — GET /docs/the-lab.md returns 200 and contains all 10 expected section headings. - test_runbook_is_featured_top_card — _FEATURED_SLUGS[0] == "the-lab". - test_docs_hub_hero_points_at_runbook — hub HTML contains href="/docs/the-lab.md" and the word "runbook". - test_dashboard_runbook_banner_renders — banner element + dismiss handler + localStorage key all present in /. Note: the README.md Quick start clone URL was also corrected from `cdarnell/autoresearch-lab` → `qukaizen/arail` (PR #60 redacted docs/ but missed root README). Same redaction pattern, same target handle. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds the missing on-ramp: a single end-to-end runbook (
docs/the-lab.md, ~600 lines, ~12 min read) that ties every surface together in one read, and promotes it as the #1 featured card on/docsplus a first-run banner on the dashboard.The Docs Hub work (PRs #56/57/59) organized 24 docs but offered no single read-through. This is that read-through — and the doc that gets featured at
qukaizen.com/docsonce the Next.js route lands.What lands
docs/the-lab.md— 10 sections: What this is · Why this matters · The two tiers · Setup in five minutes · The five surfaces (Dashboard, Chat, Autoresearch, KB, Agents — each with a "magic moment") · Buddy · Compute Source pivot · Make it yours (blueprints) · Where to go next (three guided paths) · Ask Buddy about this doc._FEATURED_SLUGSnow leads withthe-lab(replacingapi-conventions; that doc stays in Reference).📖 New to ARAIL? Read the runbook). Click →/docs/the-lab.md. Dismiss × persists inlocalStorage.arailRunbookDismissed.README.md,docs/INSTALL.md,docs/agents-explained.md,docs/BUDDY.mdeach get a "See also" pointer below the H1 so deep-landers find the runbook.cdarnell/autoresearch-lab→qukaizen/arail(PR chore(docs): redact personal handle for qukaizen.com/docs publish #60 missed the root README).Frontmatter
title: "The lab, end-to-end"·category: Getting Started·order: 0(ranks ahead of INSTALL.md's order=1) ·audience: beginner·read_minutes: 12·buddy_prompt:seeded.Test plan
pytest tests/test_docs_*.py -q→ 116 passed (was 111; 5 new tests)./docs→ "The lab, end-to-end" is the first featured card; hero copy mentions the runbook with a clickable link./→ blue runbook banner appears above the updates banner; click → lands on/docs/the-lab.md; click × → banner hides; reload → stays hidden./docs/the-lab.md→ right-rail TOC lists all 10 sections; "Ask Buddy about this doc" button at the footer; prev/next chips work.🤖 Generated with Claude Code