Repository navigation
docs: move published docs to volcano-docs - #489
Conversation
AI review: no P0-P2 findingsThis PR deletes the published 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.
Human review: not needed |
There was a problem hiding this comment.
🔵 Needs a closer look
Deleting docs/ requires maintainer coordination to first merge the still-open Kong/volcano-docs#170 with sync removal and a final snapshot preserving the five unsynced CLI pages.
No open issues 🎉
What changed in this PR
Makes Kong/volcano-docs the sole source for public CLI documentation, removing the local published copies without changing CLI runtime behavior.
Changes:
- Removes 27 documentation pages and their lint workflow.
- Updates contributor guidance to require linked companion documentation PRs and points README links to the published site.
- Clarifies the documentation-source comment;
volcano docscontinues reading the same remote source.
The migration is coordinated with upstream sync removal and preservation of the five unsynced documentation updates identified in the PR description.
| File | Description |
|---|---|
README.md |
Links to published CLI docs; drops a nonexistent page link. |
internal/docs/source.go |
Updates a source-location comment only. |
docs/variables.md |
Removes local variables guide. |
docs/telemetry.md |
Removes local telemetry guide. |
docs/storage.md |
Removes local storage guide. |
docs/share.md |
Removes local sharing and forking guide. |
docs/setup.md |
Removes local agent setup guide. |
docs/scripting.md |
Removes local scripting guide. |
docs/sandboxes.md |
Removes local sandbox guide. |
docs/README.md |
Removes local CLI overview. |
docs/project-configuration.md |
Removes local configuration reference. |
docs/notifications.md |
Removes local notifications guide. |
docs/logs.md |
Removes local logs guide. |
docs/lavaflow.md |
Removes local LavaFlow guide. |
docs/installation.md |
Removes local installation guide. |
docs/git.md |
Removes local Git connection guide. |
docs/functions.md |
Removes local functions guide. |
docs/frontends.md |
Removes local frontends guide. |
docs/feedback.md |
Removes local feedback guide. |
docs/durable-functions.md |
Removes local durable functions guide. |
docs/domains.md |
Removes local domain verification guide. |
docs/docs-search.md |
Removes local documentation search guide. |
docs/deployments.md |
Removes local deployment history guide. |
docs/deploy.md |
Removes local project deployment guide. |
docs/databases.md |
Removes local databases guide. |
docs/connect.md |
Removes local directory connection guide. |
docs/authentication.md |
Removes local authentication guide. |
docs/agent-detection.md |
Removes local agent detection guide. |
docs/access-tokens.md |
Removes local access token guide. |
CONTRIBUTING.md |
Points installation guidance to the published site. |
AGENTS.md |
Replaces local docs updates with linked companion PRs. |
.github/workflows/lint-docs.yml |
Removes linting for the deleted documentation directory. |
Review effort: Balanced
2efda9f to
087bb6d
Compare
087bb6d to
5cd0bb5
Compare
Pull request was closed
Kong/volcano-docs is now the single source of truth for the public CLI docs under content/cli. Remove docs/ and the shared docs lint workflow, point the README and CONTRIBUTING links at docs.volcano.dev/cli, and replace the 'update docs/ in the same PR' rule with a companion-PR rule.
5cd0bb5 to
5b4d02b
Compare
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-docscontent/cliis being removed, so this repository stops carrying published docs. Agents and contributors now write CLI docs directly in volcano-docs with a companion PR.What changed
docs/(27 pages). volcano-docscontent/cliowns the published copy..github/workflows/lint-docs.yml, which only ran the volcano-docs reusable lint ondocs/**. It is not a required check.AGENTS.md: replace the "updatedocs/in the same PR" rule with: public CLI docs live in Kong/volcano-docs undercontent/cli; a user-facing change opens a companion PR there. The guidance to keep maintainer material next to the code stays.README.mdandCONTRIBUTING.md: point doc links at https://docs.volcano.dev/cli. The README's "CLI operations overview" link (docs/cli/overview.md) is dropped because that page never existed.internal/docs/source.go: comment now says the CLI docs live (not are synced) undercontent/cli. No behavior change:volcano docsalready reads Kong/volcano-docscontent/at runtime.No test in this repo reads
docs/, and nothing generatesdocs/from code.docs/ vs volcano-docs content/cli
Every CLI docs change is now in volcano-docs
content/cli:docs/at19e81be. It includes the changes from feat(cli): add --project to every volcano cloud command #474, feat(functions): deploy TypeScript function handlers #428, feat(functions): deploy .tsx function handlers #482, feat(lavaflow): remove the custom context and system prompt flags #481, feat(lavaflow): show the source of a run's issue #480 and feat(databases): apply migrations in tracked runs #365 (databases.md,deploy.md).git.md), which landed after that snapshot.docs/atmain(65b50e7) now matches volcano-docscontent/cli, withREADME.mdasindex.md.Merge order
Kong/volcano-docs#170, which removes the sync, has merged, so this can merge now. A
docs/change that lands onmainbefore this PR merges must be ported to volcano-docs first.Testing
go build ./...: passedgo test ./...: passedgo tool golangci-lint run ./internal/docs/...: 0 issues/cli,/cli/installation,/cli/authentication,/cli/deploy,/cli/project-configuration,/cli/docs-searchreturn 200; an unknown path returns 404).Related
🤖 Generated with Claude Code