Skip to content

Give operators one page per task - #749

Merged
SaladDay merged 2 commits into
mainfrom
give-operators-one-page-per-task
Oct 18, 2026
Merged

SaladDay merged 2 commits into
mainfrom
give-operators-one-page-per-task

Conversation

@SaladDay

@SaladDay SaladDay commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

What changed

Operators get one page per task (audit-ia F3, F4; audit-user-pages F4, F5, F6, F9, F10, F13, F16).

  • New pages in docs/getting-started/ with zh mirrors: Configure the public address, Choose a sandbox backend, Set up workspace storage, Troubleshooting. Added to BUNDLED_DOCS.
  • Moved out of install-options, configuration, operations and nodes: listeners and ports, HTTPS and proxy, quick tunnel, change the public URL, the workspace storage how-to and quota server, the sandbox backend comparison, the troubleshooting tables. Every inbound link updated.
  • install.md: reordered to Web's checklist, prerequisites table, code groups, alerts, steps 4 and 7 shortened to links, #configure-the-domain-and-https kept as a closing section.
  • install-options.md: flags table with defaults, code group for passing flags, numbered Dokploy/Coolify steps, install.py options moved here from development.md.
  • operations.md: two command tables, IMPORTANT alert for upgrade, Exposure and Troubleshooting sections removed. nodes.md: prerequisites first, checkpoint section, alerts. configuration.md: Settings first, storage how-to reduced to a pointer, appendices.
  • Link-only edits in public-agent-api, console-server, web/index, workspace-provider (re-applied on top of Separate the node wire protocol from node storage #745).

nginx example

Verified in Docker (~/.oac/tests/docs-polish-o/run.sh, nginx 1.22 with a stand-in Web): /v1/agents returns 401 through TLS, an unknown path reaches the backend (404), Host is preserved, a WebSocket upgrade on /api/v1 echoes, and a 500 MB upload passes client_max_body_size 512m (no 413). Not run against the real Web image or on mx.

Audit claims found wrong

  • F5/F4 say the PowerShell scriptblock form belongs only in install-options; it is also in install now, per the code-group request.
  • The audit puts the HTTPS section in install-options; the IA split wins, so it lives in public-address.

Checks

Run: make check-docs, node --test website/tests/translations.test.mjs, python3 scripts/check-names.py, manifest tests.
Skipped: website build and preview screenshots, full make check.


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need.

@SaladDay
SaladDay force-pushed the give-operators-one-page-per-task branch from faa22eb to 788b356 Compare October 18, 2026 04:54
@SaladDay
SaladDay merged commit a4dd1ba into main Oct 18, 2026
@SaladDay
SaladDay deleted the give-operators-one-page-per-task branch October 18, 2026 04:54
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