Repository navigation
docs: simplify the new-user path and give each topic one owner - #225
Merged
Merged
Conversation
- 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).
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.
Part 1 of 3 of the documentation cleanup.
New-user path
install-options.md.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.
docs/api/README.mddocs/design-principles.mdoperations.mdconfiguration.mdself-hosted.mduser-guide.mdValidation
Run on the final stacked head (#226):
make check-docspasses.check-namespasses.#226 (API guide and examples) adds anchors this PR links to. Merge the two back to back.
Need help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.