Skip to content

docs(agentos): rewrite README and quickstarts [skip ci] - #2041

Merged
NathanFlurry merged 22 commits into
mainfrom
docs/readme-refresh
Oct 13, 2026
Merged

NathanFlurry merged 22 commits into
mainfrom
docs/readme-refresh

Conversation

@NathanFlurry

Copy link
Copy Markdown
Member

Rewrites the agentOS README (header, Why agentOS, benchmarks, quickstarts, architecture diagram, API overview) and restructures the library and hosted quickstart docs into steps with a configure step. Adds a CLAUDE.md rule to keep the README API table a superset of library methods and hosted actions.

Amp-Thread-ID: https://ampcode.com/threads/T-2a1435a9-d419-46ec-b16e-c09af0924c76

Nathaneil Flurry and others added 22 commits October 13, 2026 02:35
…starts

- Change the tagline and re-center the logo box on the wordmark.
- Add Benchmarks and Architecture sections with a light and dark diagram.
- Center the quickstart diagram and label the two modes with "or".
- Trim the library and hosted examples.
- Collapse the API Overview into one superset Methods column and document
  that rule in CLAUDE.md.

Amp-Thread-ID: https://ampcode.com/threads/T-2a1435a9-d419-46ec-b16e-c09af0924c76
Co-authored-by: Amp <amp@ampcode.com>
…hten prose

- Fold the library usage step into step 2 and add a configure step with
  persistence, mounts, environment, permissions, and limits.
- Add a hosted configure step with a durable root and config.patch.
- Move Architecture above the API Overview.
- Remove the software paragraph and the API naming note.
- Rephrase the architecture prose without colons or semicolons.

Amp-Thread-ID: https://ampcode.com/threads/T-2a1435a9-d419-46ec-b16e-c09af0924c76
Co-authored-by: Amp <amp@ampcode.com>
…with a configure step

- Library: install, create and use (bash, filesystem, JavaScript, Python), and
  configure (SQLite root, mounts, environment, permissions, limits) from
  checked examples.
- Hosted: project, client, create and use with a preview URL, and configure
  with a durable root, mounts, environment, and permissions over TypeScript
  and HTTP.
- Trim the mode comparison table to match the README.

Amp-Thread-ID: https://ampcode.com/threads/T-2a1435a9-d419-46ec-b16e-c09af0924c76
@railway-app

railway-app Bot commented Oct 13, 2026

Copy link
Copy Markdown

🚅 Environment agentos-pr-2041 in rivet-frontend has no services deployed.

8 services not affected by this PR
  • kitchen-sink
  • frontend-inspector
  • mcp-hub
  • sentry-tunnel
  • ladle
  • website
  • frontend-cloud-ee
  • frontend-cloud

@NathanFlurry
NathanFlurry merged commit 4d48628 into main Oct 13, 2026
4 of 6 checks passed
@NathanFlurry
NathanFlurry deleted the docs/readme-refresh branch October 13, 2026 05: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