[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/ruby 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/ruby 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.
• .github/scripts/quickstart.rb: 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 the built gem (.github/scripts/smoke-gem.sh, run by rake quality:package 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/ruby; 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/ruby, keeping section anchors.

docs/ vs volcano-docs content/sdk/ruby

Compared docs/ at origin/main (e3082cc) with volcano-docs content/sdk/ruby 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

• bundle exec rake quality:package (build the gem, isolated install, quickstart): passed, "Documented quickstart passed (synthetic HTTP)"
• bundle exec rake quality:lint (RuboCop): 417 files, no offenses
• Ran with Ruby 3.4.12.
• 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-python.

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 volcano-sdk-python#426
• docs: move published docs to volcano-docs #373

🤖 Generated with Claude Code

[github-actions]

AI review: no P0-P2 findings

Reviewed 7f9a37f. Run log

This PR deletes docs/ and the docs lint workflow, because Kong/volcano-docs content/sdk/ruby now owns the published Ruby guides. It points README and maintainer links at docs.volcano.dev, rewrites the docs rule in AGENTS.md and CONTRIBUTING.md, and copies the quickstart into the package smoke check. A later commit also bumps the locked dev version of rack from 3.2.7 to 3.2.8 to clear bundle-audit advisories. Nothing left in the repository reads docs/, and the copied quickstart matches the deleted snippet exactly. The remaining risks are that the copy can drift from the published page, and that the merge has to wait for the volcano-docs sync removal.

⚪ P3

• .github/scripts/quickstart.rb:11 Package quickstart check now runs a hand-copied snippet and can drift from the published quickstart
• README.md:5 Links in already-published gem READMEs to blob/main/docs/ will 404 once docs/ is deleted

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 the Kong/volcano-docs PR removing the docs/ sync has merged, and how that sync behaves if it runs after docs/ is gone.
• Whether every new docs.volcano.dev link and anchor in README.md and maintainers/releasing.md resolves on the live site.
• Whether volcano-docs content/sdk/ruby really matches the deleted docs/ content, as the description says.
• Whether bundle-audit passes with rack 3.2.8 and no other locked gem still triggers advisories.
• Confirm Kong/volcano-docs retains all ten removed Ruby guides and that the replacement URLs and anchors resolve.

Human review: needed

• Has the Kong/volcano-docs PR removing the daily docs/ sync merged? If this PR merges first, that sync loses its source and could fail or overwrite the published content/sdk/ruby pages.

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

Suggested reviewer: subnetmarco (most recent committer to README.md and docs/functions.md, the main docs this PR moves). Any collaborator with write access other than the author can approve.

[github-actions]

⚪ P3: Package quickstart check now runs a hand-copied snippet and can drift from the published quickstart

The check used to pull the quickstart out of docs/README.md, so changing the published example automatically changed what smoke-gem.sh ran against the built gem. Now EXAMPLE is a separate copy, kept in sync only by the comment "Change both together." If someone edits the quickstart in Kong/volcano-docs content/sdk/ruby/index.md, this check keeps passing on the old copy. It still prints Documented quickstart passed (.github/scripts/smoke-gem.sh:40), and maintainers/releasing.md:39 still calls it "the exact public quickstart." Neither is accurate any more. One fix is to have volcano-docs run its own snippet against a released gem. Another is to reword the message and the release guide so they say the check runs a local copy, not the published page.

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

[github-actions]

⚪ P3: Links in already-published gem READMEs to blob/main/docs/ will 404 once docs/ is deleted

Released gems up to 0.35.1 bundle a README.md whose links point to https://github.com/Kong/volcano-sdk-ruby/blob/main/docs/README.md, docs/authentication.md, docs/functions.md, docs/logs.md and docs/locks.md. After this PR those GitHub URLs return 404 for anyone reading an installed gem's README or following an old external link. A small docs/README.md stub that points to https://docs.volcano.dev/sdk/ruby would keep those links working. Leaving them broken is also acceptable.

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

[github-actions]

⚪ P3: Package check can drift from the published quickstart

EXAMPLE now duplicates the documentation, so a future volcano-docs edit can leave package CI exercising an older snippet. .github/scripts/smoke-gem.sh:40 still reports Documented quickstart passed, and maintainers/releasing.md describes it as the public quickstart. Clarify that the check validates a local copy, or validate the published snippet in the docs repository.

_{Found by gpt-6.1-sol}

[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 7f9a37fed91f4926041913e62c819911a8729b44. All 10 SDK guide files on current main match volcano-docs/content/sdk/ruby (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 and Rack lockfile update, 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 7f9a37fed91f4926041913e62c819911a8729b44 for the reviewed docs migration and Rack lockfile update. 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.