docs: rebuild operator guides around one owner per subject - #261
Merged
Merged
Conversation
…d one configuration reference install.md keeps only the default path; flags, external proxies, modes, split and native Core move to install-options.md. configuration.md owns the directory layout, every Core environment variable and the Runtime history bounds (rendered from the schema), replacing services/agents-api/runtime-history/README.md. operations.md gains oac domain, the single version policy, Core API scripting and corrected listener facts.
nodes.md now holds every operator node task: manual registration, the sandbox configuration steps in Web, host failure and one readiness table with current Web labels and runtime_download_failed. Node machine routes join the sandbox deployment route table. HOSTED-SANDBOX-MANAGER.md leaves the repository, the standalone archive and the bundled docs; inbound links point at the nodes guide or the contract.
Readiness reasons follow the node type, duplicated facts become links, runtime_home and Docker backend rules are exact, and configuration.md regains the native path rule and the Runtime history validation rules. RELEASE.md is left to its owning PR.
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/getting-started/README.md): one table for operators and one for application developers. The duplicate step list is removed.install.md): only the default path remains, down from 466 to 90 lines: prerequisites, install, sign in, domain and HTTPS, default model, Project API key, add capacity.install-options.md): now "Installation options and advanced deployments". It covers installer options, sandbox backend, listeners, reverse proxy (Caddy, nginx), quick tunnel, modes, split deployment, native Core and offline hosts.configuration.md): the only home of setting names, defaults, files, the installation directory and the Core environment-variable table. Runtime history bounds now live in thecore.runtime_history.*rows (text inconfig.schema.jsondescriptions only).nodes.md): every operator node task, including manual registration, host failure, one readiness table that matches Web's labels, and installer messages.services/agents-api/HOSTED-SANDBOX-MANAGER.mdis folded in and deleted. Its node machine routes moved to the sandbox deployment contract.operations.md): theoaccommand (now withoac domain), scripting the Core API, the single installation version policy, and troubleshooting.quickstart.md): links model-provider precedence instead of restating it.services/agents-api/runtime-history/README.md;.env.examplepoints to the configuration reference.Stale claims fixed
runtime_download_failed. Nodes added with Web's command show their failure reason under Preparation failed.Verification
make check-names,make check-docs,make check-distributionscripts/config-reference.py --checkdeploy/installtests (237)Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.