Skip to content

docs: simplify the new-user path and give each topic one owner - #225

Merged
SaladDay merged 1 commit into
mainfrom
docs/user-path
Sep 29, 2026
Merged

SaladDay merged 1 commit into
mainfrom
docs/user-path

Conversation

@SaladDay

@SaladDay SaladDay commented Sep 29, 2026 •

Copy link
Copy Markdown
Collaborator

Part 1 of 3 of the documentation cleanup.

New-user path

  • README (en/zh): what the project is, a four-step install, the two APIs, and a "what do you want to do" documentation table.
  • Installation: the default path comes first: prerequisites → install → make Core reachable → sign in → next steps. Backends, modes, split deployment and the directory layout move under "Advanced installation". Flags stay owned by install-options.md.
  • Quickstart: three steps from a Project API key to a finished Session. The model provider is optional when the installation has a default model.
  • User guide: task-oriented. It is now the single owner of Environment kinds, harness and model choice, and model provider precedence, including the unified model configuration (harness_config, and the model can be omitted for inline hosted Sessions).

One owner per topic

Each topic below now has one owner document; other places link to it instead of restating it.

Topic Owner
Namespaces and credentials docs/api/README.md
Projects and keys, administrator authority, isolation docs/design-principles.md
Key-rotation steps operations.md
Backend and size changes configuration.md
Executor credential rotation self-hosted.md
Model precedence user-guide.md

Validation

Run on the final stacked head (#226):

  • make check-docs passes.
  • check-names passes.
  • A link and anchor check over all tracked Markdown passes.

#226 (API guide and examples) adds anchors this PR links to. Merge the two back to back.


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

- README: what the project is, a four-step install, the two APIs and a
  documentation table by goal (English and Chinese).
- Installation: the default path first (prerequisites, install, reachability,
  sign-in, next steps); version, sandbox backend, modes, split deployment and
  directory layout move to "Advanced installation".
- Quickstart: three steps from a Project API key to a finished Session.
- User guide: task-oriented, and now the single owner of Environment kinds,
  harness and model choice, and model provider precedence.
- Remove repeated explanations and link to one owner instead: namespaces and
  credentials (API index), Projects and keys and administrator authority and
  isolation (design principles), key rotation steps (operations), backend and
  size changes (configuration), executor credential rotation (self-hosted).
@SaladDay
SaladDay merged commit e6f79ad into main Sep 29, 2026
1 of 2 checks passed
@SaladDay
SaladDay deleted the docs/user-path branch October 7, 2026 06:38
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