Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 0 additions & 15 deletions .github/workflows/lint-docs.yml

This file was deleted.

34 changes: 9 additions & 25 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,14 @@

## Documentation

Everything under `docs/` is **published** — CI syncs it to the public developer
docs site (`Kong/volcano-docs`). So `docs/` is for **end-user-facing docs only**:
the commands, flags, and behavior a Volcano user relies on.
Public CLI docs live in [`Kong/volcano-docs`](https://github.com/Kong/volcano-docs)
under `content/cli` and publish to https://docs.volcano.dev/cli. This
repository no longer carries published docs.

**When you add or change user-facing behavior, update the matching doc under
`docs/` in the same PR.** Do **not** put internal or maintainer material in
`docs/` — dev-only env vars and overrides (e.g. pointing the CLI at a specific
API endpoint for local testing), design notes, or implementation detail. That
lives **next to the code it describes**: a code comment, or a notes/README file
in the relevant package — never under `docs/`, which is the sync target. When
unsure whether something is meant for users, keep it out of `docs/`.
**When you add or change user-facing behavior, open a companion PR in
`Kong/volcano-docs` that updates `content/cli`**, following its format contract
(`spec/markdown-format.md`), and link the two PRs.

Every doc must follow the Volcano docs format
(https://github.com/Kong/volcano-docs/blob/main/spec/markdown-format.md):

- YAML frontmatter with **`title`** and **`description`** (both required).
- **No H1 in the body** — the title comes from frontmatter; start at `##`.
- `kebab-case.md` filenames; `_index.md` (or `README.md`) for a section landing.
- Every fenced code block declares a language.
- For links within `docs/`, use a relative path with the `.md` extension. For
links to another docs section, use a site-absolute path without an extension,
such as `/platform/functions/overview` or `/sdk/js/authentication`. Do not use
source-root paths such as `/commands`; this repository is synced under `/cli`.

The shared lint (`.github/workflows/lint-docs.yml`) validates this on PRs that
touch `docs/`, and `internal/docs` parses the frontmatter for `volcano docs
search`, so malformed docs fail CI.
Keep internal or maintainer material — dev-only env vars and overrides, design
notes, implementation detail — next to the code it describes: a code comment,
or a notes/README file in the relevant package.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,4 +162,4 @@ curl -fsSL https://download.volcano.dev/builds/install.sh | bash

Set `VOLCANO_VERSION=vMAJOR.MINOR.PATCH` to install a pinned release. To verify
the installer against `install.sh.sigstore.json` before running it, follow
[Installation](docs/installation.md).
[Installation](https://docs.volcano.dev/cli/installation).
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,13 @@ files, migrations directory, and README). Use a template to add
language-specific files: `javascript` (aliases: `js`, `node`, `nodejs`),
`nextjs`, `python`, or `ruby`.

More detail lives in `docs/`:

- [Installation details](docs/installation.md)
- [Authentication](docs/authentication.md)
- [Deploy a project](docs/deploy.md)
- [Project configuration](docs/project-configuration.md)
- [CLI operations overview](docs/cli/overview.md)
- [Documentation search (`volcano docs`)](docs/docs-search.md)
More detail lives in the [CLI docs](https://docs.volcano.dev/cli):

- [Installation details](https://docs.volcano.dev/cli/installation)
- [Authentication](https://docs.volcano.dev/cli/authentication)
- [Deploy a project](https://docs.volcano.dev/cli/deploy)
- [Project configuration](https://docs.volcano.dev/cli/project-configuration)
- [Documentation search (`volcano docs`)](https://docs.volcano.dev/cli/docs-search)

## Contributing

Expand Down
270 changes: 0 additions & 270 deletions docs/README.md

This file was deleted.

Loading
Loading