docs: improve installation, deployment, and API guides - #1374
Open
Teingi wants to merge 3 commits into
Open
Conversation
# Conflicts: # docs/en/docs/how-to/install-and-run.md # docs/en/docs/reference/interfaces.md # docs/zh/docs/how-to/install-and-run.md # docs/zh/docs/reference/interfaces.md
Collaborator
|
conflict on docs |
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.
Which issue or RFC does this PR close?
N/A.
Rationale for this change
The user documentation mixed released-package and source-installation assumptions, lacked a practical deployment path and human-oriented HTTP API entry point, and presented unpublished adapters as directly installable. This made common installation and integration tasks harder to follow and could lead to failed installs or unsafe network exposure.
What changes are included in this PR?
masterGit ref.setup select,doctor integrations, and the explicit WorkBuddy commands now present onmaster.No runtime code, OpenAPI contract, generated source, dependency, or persisted-data format is changed.
Are there any user-facing changes?
Yes. Installation, deployment, API, Docker, and integration documentation is reorganized and corrected in English and Chinese. The normal Git-based installation path now follows
master; unpublished adapters no longer show commands that imply a PyPI release exists. There are no breaking API or persisted-format changes.How was this change tested?
make checkmake docs-testmake contract-test(29 passed)uv run pytest tests/test_doctor_integrations.py tests/test_setup_select.py(33 passed)uv run pytest tests/pydantic_ai_adapter/test_packaging.py(4 passed)uv run pytest tests/test_docs_remote_access_contract.py tests/test_docker_contract.py(9 passed)uvdependency resolution confirmed that the unreleased Pydantic AI adapter cannot currently resolve against the public ormastercore packagemake test: 892 passed, 9 skipped, and 1 host E2E failed because the installed OpenCode 1.18.21 did not invoke the capture hook. The same failure was reproduced from an unmodifiedorigin/masterarchive in this environment.AI usage statement
OpenAI Codex (GPT-5) assisted with the documentation audit, editing, merge conflict resolution, and validation. The resulting commands, links, package status, OpenAPI behavior, and Server behavior were checked against the repository and local runtime.