[swkeever]

Why

Kong/volcano-docs becomes the single source of truth for all public Volcano docs. The daily cross-repo sync that copied this repo's docs/ into volcano-docs content/sdk/python is being removed, so this repository stops carrying published docs. Agents and contributors now write SDK docs directly in volcano-docs with a companion PR.

What changed

• Remove docs/ (10 guides). volcano-docs content/sdk/python owns the published copy.
• Remove .github/workflows/lint-docs.yml, which only ran the volcano-docs reusable lint on docs/**. It is not a required check.
• tests/package/quickstart.py: the package quickstart check read the "Sign in and read a profile" snippet from docs/README.md. The snippet now lives inline in the script, identical to the published one (checked against docs/README.md at origin/main), with a comment naming the volcano-docs page it mirrors. The check still runs that quickstart against synthetic auth responses from each built wheel and sdist (scripts/check_package.sh, run by poe package-check in CI and by the release workflow). volcano-docs owns the published copy; change both together.
• AGENTS.md, CONTRIBUTING.md: replace "docs/ is published" with: public SDK docs live in Kong/volcano-docs under content/sdk/python; a user-facing change opens a companion PR there.
• README.md, maintainers/releasing.md: point docs/ links (GitHub blob URLs and relative paths) at https://docs.volcano.dev/sdk/python, keeping section anchors.

docs/ vs volcano-docs content/sdk/python

Compared docs/ at origin/main (340c9a3) with volcano-docs content/sdk/python at origin/main (c9b71bf), with README.md mapped to index.md: identical (same files, no content differences). Nothing to port.

Merge order

Merge only after the volcano-docs PR that removes the sync has merged; until then the daily sync would fail on the missing docs/ path.

Testing

• uv run poe package-check (build wheel and sdist, isolated installs, quickstart per artifact, consumer type checks): passed, "Documented quickstart passed (synthetic HTTP)"
• uv run poe policy, lint (ruff), format-check, types (mypy, basedpyright): passed
• Local note: the repo requires uv >= 0.12.17; ran with uv 0.12.17 via uvx because the installed uv is 0.12.7.
• Checked every new docs.volcano.dev link returns 200, and that the linked anchors exist on the live pages.

Cross-language impact

Classification: none (no SDK behavior change). Companion PRs make the same change in Kong/volcano-sdk-js and Kong/volcano-sdk-ruby.

Related

• docs: move published docs to volcano-docs volcano-cli#489
• docs(guides): move published docs to volcano-docs volcano-sdk-js#367
• docs: move published docs to volcano-docs #426
• docs: move published docs to volcano-docs volcano-sdk-ruby#373

🤖 Generated with Claude Code

[github-actions]

AI review: no P0-P2 findings

Reviewed 623e6e3. Run log

This PR removes the published docs/ directory and the lint-docs.yml workflow from this repo. It points README and maintainer links at docs.volcano.dev/sdk/python, updates the docs rule in AGENTS.md and CONTRIBUTING.md, and puts the package quickstart in tests/package/quickstart.py instead of reading it from docs/README.md. Nothing else in the repo reads docs/, and the inline snippet matches the deleted one exactly, so the code risk is low. The main risk is merge order: Kong/volcano-docs still syncs this repo's docs/ every day.

⚪ P3

• tests/package/quickstart.py:90 The inline quickstart can drift from the published volcano-docs page with no check
• README.md:61 The PyPI page for 0.16.0 and earlier releases will link to deleted GitHub docs

Not checked: The AI review read the diff, the code, and the PR's text; it ran no tests or builds and read nothing outside this repository.

• Whether volcano-docs content/sdk/python really matches the deleted docs/ files; the description says they match at volcano-docs c9b71bf.
• Whether the new docs.volcano.dev/sdk/python URLs and their section anchors resolve.
• Whether the volcano-docs sync removal has merged.
• Whether Lint docs is a required status check in branch protection.
• Confirm Kong/volcano-docs retains all ten guides and the published quickstart, with working link targets and anchors.

Human review: needed

• Has the Kong/volcano-docs PR that removes the daily sync of this repo's docs/ merged? If it hasn't, deleting docs/ here breaks that sync.
• Is it acceptable that tests/package/quickstart.py now checks an inline copy rather than the published quickstart, with nothing keeping the two in sync?

The AI review found no P0-P2 problems at 623e6e3, so the code needs no second review for bugs. Decide the points above: approve to accept them, or request changes.

Suggested reviewer: tkkhq (edited docs/README.md, where the quickstart lived, plus README.md and docs/functions.md). Any collaborator with write access other than the author can approve.

[github-actions]

⚪ P3: The inline quickstart can drift from the published volcano-docs page with no check

Before this PR, run_quickstart() pulled the snippet from docs/README.md, so check_package.sh always ran the exact published quickstart against each wheel and sdist. Now it runs a copy kept in QUICKSTART, and only a comment asks people to "change both together". If someone edits content/sdk/python/index.md in volcano-docs and not this file, CI still prints Documented quickstart passed. maintainers/releasing.md:56 still says "run the exact public quickstart". The two match today, so nothing is broken yet. To make the guarantee hold, add a parity check on the volcano-docs side, for example one that compares its snippet with this file at a pinned SHA. Otherwise, soften the check_package.sh message and the releasing.md wording so they don't claim the published copy was tested.

_{Found by claude-opus-5-5}

[tkkhq]

Conditional approval from my side with all required CI checks passing on the revision that merges, including any required merge-queue checks, and no merge conflicts.

Reviewed 623e6e3d376a29b2c17d7013de2d8e9d1c0c263a. All 10 SDK guide files on current main match volcano-docs/content/sdk/python (mapping the root README to index.md), and Kong/volcano-docs#170 has merged and removed the sync. The current-head checks are green and GitHub reports no merge conflict. No additional docs content needs porting based on this comparison.

Nonblocking follow-up: keep the package quickstart copy aligned with the published example, ideally through a parity check in volcano-docs CI. This is a maintenance follow-up, not an approval condition.

Assuming any further update stays within the reviewed migration, this is good to merge from my side once the conditions above are met. Verification used source comparison and existing CI results; I did not rerun builds or tests locally.

[tkkhq]

Approved at 623e6e3d376a29b2c17d7013de2d8e9d1c0c263a for the reviewed docs migration. The 10 SDK guides match volcano-docs, and the sync has been removed. All required CI and merge-queue checks must pass on the revision that merges, with no merge conflicts. Keeping the package quickstart copy aligned with the published example remains a nonblocking follow-up.