Skip to content

Rewrite get-started so a human can install - #193

Merged
abrichr merged 2 commits into
mainfrom
docs/get-started-human-2026-09-01
Sep 1, 2026
Merged

Rewrite get-started so a human can install#193
abrichr merged 2 commits into
mainfrom
docs/get-started-human-2026-09-01

Conversation

@abrichr

@abrichr abrichr commented Sep 1, 2026

Copy link
Copy Markdown
Member

The live get-started page opened with "The default reader is the calling agent" and led with claude mcp add. That's the wrong door. The person who lands here wants an agent to do a job on this computer. They install first.

What this PR does

docs/get-started/index.md is a rewrite, not a polish pass. Install is the required first success. Desktop and pip are equal. If they came from a job page, they go back to /j/{id}. The bundled tutorial (openadapt quickstart, optionally --break-it) is optional and doesn't name MockMed. MCP for Claude Code and Cursor sits later. Qualification, Seal, compose, and oracle tiers are gone from this page.

Aliases no longer dump the tutorial-first lecture:

  • docs/start/index.md
  • docs/getting-started/index.md
  • docs/getting-started/quickstart.md
  • docs/getting-started/installation.md

docs/llms.txt no longer cites MCP as the first get-started step. The docs home primary button and matching card now say "Install OpenAdapt" instead of "Call it from an agent".

Validator strings still required on get-started, and still present, just not in the lead:

  • pip install
  • openadapt quickstart
  • --break-it
  • tutorial
  • first-workflow.md
  • claude mcp add openadapt
  • Never summarize halt as success

--break-it stays forbidden in first-workflow.md. This PR doesn't add it there.

Left alone

first-workflow.md, what-you-get.md, Seal, qualify, compose, and the commercial execute pages. The homepage lede and calling-agent contract box still have to say "calling agent". openadapt-web 462 is a separate change.

CI

The Vendored design tokens match openadapt-web check returned HTTP 404 on https://raw.githubusercontent.com/OpenAdaptAI/openadapt-web/main/styles/tokens.json because that repo is private. Same hole as desktop 154.

--check now reads those files from the GitHub Contents API: GET /repos/OpenAdaptAI/openadapt-web/contents/styles/<file>?ref=main with Accept: application/vnd.github.raw. The job sets GITHUB_TOKEN from secrets.ADMIN_TOKEN, falling back to github.token. github.token can't read a private sibling repo. A 404 still fails the job. It does not count as a match.

Opened by an agent session, not the founder.

…uter

The live opener treated the calling agent as the default reader and led
with claude mcp add. Humans install Desktop or pip first. Tutorial is
optional. Validator strings stay on the page, not in the lead.
openadapt-web is private, so raw.githubusercontent.com 404s in Actions.
Match desktop #154: Contents API + ADMIN_TOKEN, fail closed on HTTP errors.
url = request.full_url
requested.append(url)
authed.append(request.has_header("Authorization"))
if "raw.githubusercontent.com" in url:
assert vendor.main() == 0
assert any("/contents/styles/tokens.json" in url for url in requested)
assert any("/contents/styles/tokens.css" in url for url in requested)
assert not any("raw.githubusercontent.com" in url for url in requested)
@abrichr
abrichr merged commit 22926f7 into main Sep 1, 2026
5 of 6 checks passed
@abrichr
abrichr deleted the docs/get-started-human-2026-09-01 branch September 1, 2026 21:01
@abrichr

abrichr commented Sep 1, 2026

Copy link
Copy Markdown
Member Author

Merged by an agent session, not the founder.

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.

2 participants