docs: limit maintainer guide to build and release; merge self-hosted guides - #258
Merged
Merged
Conversation
Add the installation grant, its machine routes and claim rules, the break-glass command, the park-after-rejection behavior and compute-owner cleanup. Fix the stale connection-confirmation text (the native installer polls once a second for 45 seconds and points to connect.log) and the ambiguous 409 for a second key on a bound Environment.
docs/getting-started/self-hosted.md now covers platforms, connecting, automation options, operating oac-daemon, adding Harnesses, rotation and manual installation. The Windows npm/npx launcher rule moves to the Environment contract. Remove docs/self-hosted-native.md and its site page, and point the Web install panel and every inbound link at the merged guide.
Configuration and apply, versions and the lock, install-time sandbox selection, accounts, managed HTTPS, output, the node installer, the download contract, image identity and the native daemon installer, without the historical notes.
docs/maintainers.md now covers distribution builds, native installers, Runtime image and helper builds (moved from the deploy and tool READMEs, with the msb archive checksum), standalone Core builds, publication, candidates, CI and running Core without the installer, which absorbs the standalone container guide. Fix the stale five-command count and the release job ordering. Trim the standalone archive README to its own steps and fix its link targets. Release promotion rules move to the promote-qualified-release.py docstring and the E2B template umask rule to the template builder's README.
Unwrap the Markdown files this PR owns (unwrap_md.py; rendering verified identical with render_equal.mjs) and regenerate the docs site. Let the service README's name allowlist entry match its line wrapped or not.
Describe the promotion path that works (flat candidate files; the command creates its own draft) and keep the docstring's paragraphs in --help. Correct the release recovery, host requirements, Claude and MiniMax build hosts, native-check triggers, cache scope, catalog contents and archive contents. Split rules from steps between the credential contract and the self-hosted guide, complete the break-glass command, and fix the installer rules on uninstall exceptions, root file removal, the download contract and native catalog handling.
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.
Part of the documentation overhaul (one owner per subject, grouped content, plain tone, no historical copies, no hard wraps).
Changes
docs/maintainers.mdcovers build and release only: building a distribution, Runtime images and helpers, standalone Core builds, publishing a version, promoting a qualified candidate, CI coverage, and running Core without the installer. It drops from 706 to 187 lines.deploy/install/README.mdholds the installer design rules (config and apply, versions and the lock, managed HTTPS, node installer, download contract, image identity, native daemon installer).docs/self-hosted-native.mdis merged intodocs/getting-started/self-hosted.md, which becomes the single application-developer guide for self-hosted machines. The Web Connect a host docs link and its test point there.contracts/agents-api/environment-executor-credentials.mdis the single contract for executor credentials and the installation grant, including the break-glass command.services/agents-api/CONTAINER.mdis deleted; its run flags live under "Run Core without the installer".services/agents-api/RELEASE.mdkeeps its path and placeholders and is trimmed.scripts/promote-qualified-release.pydocstring.--helpnow keeps its paragraphs; there is no behavior change.Stale claims fixed
sha256sum.Known gap (code, not changed here)
promote-qualified-release.pyrejects theinstall.shandinstall.sh.sha256assets that the release workflow uploads. A promoted Release therefore has no one-command installer.Verification
make check-names,make check-docs,make check-distributionpromote-qualified-release.test.py,publish-core-release.test.pyNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.