Repository navigation
Rewrite the install docs: three steps in the README and one guide for every option - #161
Merged
Merged
Conversation
…node README starts with the three newcomer steps, each linking to one detailed guide. docs/getting-started now covers installation (every install.sh option, Caddy and nginx examples, a quick-tunnel trial, what is created on disk), nodes (the Web command in sudo and no-sudo form, uninstall, logs, readiness codes), self-hosted executors, operations (parsar, the Core key, backups, upgrades, troubleshooting) and the application quickstart with OPENAI_BASE_URL and OPENAI_API_KEY. docs/configuration.md lists the config.json settings and the runtime settings in Web. HOSTED-SANDBOX-MANAGER.md becomes the operator reference without repeating the guides. The Docker-hosted Agents API archive could not carry a complete Runtime release, so HOSTED-RELEASE.md and its build step are removed; the standalone archive and container move under docs/maintainers.md. Distributions now carry a fixed list of docs whose links stay inside the bundle or point at the bundle's commit on GitHub, and the build fails on a broken link or anchor.
The link scanner split each line on code spans first, so a link such as [`config.json`](path) was neither rewritten nor checked, and three dead relative links shipped. Links are now found on the whole line, skipping only code spans outside link text. Anchors follow GitHub's rules for closing hashes and emphasis, fenced blocks close only on a matching fence, and indented code blocks are skipped. The README banner ships with the bundle so it renders offline.
- Web-only: --core-url must reach Core's /core/v1 directly (loopback, or a second HTTPS name proxying everything to Core); document the split deployment's proxies. - Conversion: back up with the old top-level compose.json before --yes; rename only the pre-Core-key names by hand and leave the rest, and AGENTS_API_PUBLIC_URL, to --convert. - Quickstart: read the key without echo or history, keep it off curl's command line, name the none rejection, and ask for the default provider's model ID. - README: follow the docs inside the downloaded bundle; Overview's checklist. - Upgrades between config.json releases are not supported yet; /api/v1 routing applies to every sandbox kind; rotate-core-key on a stopped installation. - Nodes: Retained sandboxes is microsandbox only, the early 401 message, the log command, user-manager restart without sudo, Web's labels for readiness codes and removal, NODE_USER, and a neutral note on changing the backend. - Self-hosted: Web's labels and dialog, the credential file name, the Docker CLI and root refusal, the rerun refusal after an upgrade or address change, archived projects. - Configuration: Startup settings, Rename, what credential.key seals, the executor consequence of a public URL change, the full retired list. - Claude Code is the display name of harness claude_sdk.
Self-hosted executors download their installer from Core's public URL, but Web serves /node-install/* only for its own name. The split deployment's Core host now sends /node-install/* to the Web host with Host rewritten, restricts the core-api name to the Web host, and has Caddy and nginx examples checked against the console's Host check. The Web host needs the node files when the deployment has nodes or executors. Moving a self-hosted executor to a new release or public URL is stated as not supported yet. The bundle docs build refuses a link that spans lines, since links are read line by line, and handles an image inside link text. Long lines are rewrapped, and placeholders use NODE_USER.
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
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
Phase 4 of the new-user install work rewrites the install documentation. Someone who opens the repository sees how to install Core and Web in three steps, and there is one detailed guide for every option. The docs describe what main does now.
Pages
docs/getting-started/install.md):gh auth loginas its own step, thengh release downloadand checksum verification;install.shoption;nodes.md: the sudo and no-sudo commands exactly as Web builds them, what sudo mode creates, the Docker root-equivalence warning, uninstall and--force, and a readiness-code table with the labels Web shows;self-hosted.md;docs/maintainers.md.operations.md: theparsarcommands, the Core key, backups,--convertupgrades with a pre-conversion backup, retired names and troubleshooting;quickstart.md:OPENAI_BASE_URL/OPENAI_API_KEY, with the key kept out of shell history and argv;configuration.md: the generatedconfig.jsontable, howparsar applyworks and what it restarts, and the runtime settings in Web.HOSTED-SANDBOX-MANAGER.mdbecomes the operator reference, linked from the nodes guide rather than duplicated.Legacy paths
services/agents-api/HOSTED-RELEASE.md, which could not supply a complete Runtime release on its own, together with its packaging step.RELEASE.mdandCONTAINER.mdare labelled advanced and linked only from the maintainers page.Offline bundle
core-distribution-manifest.py docsstep, driven by a fixed list, builds the bundled docs.Terms
OPENAI_*.claude_sdkis shown as "Claude Code".Deferred on purpose
oacrename is a separate series of PRs.Review
9c6fd991andfe781f4a.41de66df, verified against a realcore-consolebehind both proxy configs.Verification
install-docs-r3) passed on41de66df. Playwright browser cases were skipped on the server (Chrome unavailable; approved skip).26224d04(Clearer projects and Sessions: archive consequences, failure reasons, how to call #158 and Accept any Runtime image name in the Runtime reference #160 are Web-only and overlap no files here):config-reference.py --checkand the manifest tests pass, and a relative-link check over all 91 Markdown files finds none broken.caddy validateand nginx passesnginx -t. Both were live-tested for routing, Host handling and WebSocket upgrades.Need help on this PR? Tag
@codesmithwith what you need. Autofix is disabled.