From 348a0434d49ccfa5debd42ef19eb8adf51e2c597 Mon Sep 17 00:00:00 2001 From: nfebe Date: Tue, 8 Sep 2026 01:16:46 +0100 Subject: [PATCH] docs: Move versioning guidance out of the readme --- .github/workflows/validate-docs.yml | 17 +++++++++++++++++ README.md | 6 ------ docs.json | 14 ++++++++++++++ docs/versioning.md | 11 +++++++++++ 4 files changed, 42 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/validate-docs.yml create mode 100644 docs.json create mode 100644 docs/versioning.md diff --git a/.github/workflows/validate-docs.yml b/.github/workflows/validate-docs.yml new file mode 100644 index 0000000..c917178 --- /dev/null +++ b/.github/workflows/validate-docs.yml @@ -0,0 +1,17 @@ +name: Validate Docs + +on: + push: + paths: ['docs/**', 'docs.json', '.github/workflows/validate-docs.yml'] + pull_request: + paths: ['docs/**', 'docs.json', '.github/workflows/validate-docs.yml'] + +permissions: + contents: read + +jobs: + validate: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: whilesmart/docs-kit/.github/actions/validate-docs@main diff --git a/README.md b/README.md index b235992..9f02ab4 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,3 @@ make build ## Licence MIT. - -## Versioning - -The agent is versioned independently of the CLI, core, and design package. Its release number does not select the core version. Setup records the core image or Python executable that the agent starts. - -Agent `1.0.0-beta.3` uses core `1.0.0-beta.2` as its compatibility baseline. Older cores are outside this release's supported baseline. No maximum core version is declared; this does not promise compatibility with future beta releases. Startup checks core health but does not enforce a version range. Select a known core release with `sourceant setup --core-version 1.0.0-beta.2`. diff --git a/docs.json b/docs.json new file mode 100644 index 0000000..f107e5b --- /dev/null +++ b/docs.json @@ -0,0 +1,14 @@ +{ + "$schema": "https://raw.githubusercontent.com/whilesmart/docs-kit/main/schema/docs.schema.json", + "name": "SourceAnt agent", + "description": "Run the local SourceAnt stack.", + "category": { + "language": "go" + }, + "sidebar": [ + { + "title": "Versions", + "path": "docs/versioning.md" + } + ] +} diff --git a/docs/versioning.md b/docs/versioning.md new file mode 100644 index 0000000..df39a49 --- /dev/null +++ b/docs/versioning.md @@ -0,0 +1,11 @@ +# Versions + +The agent and core are versioned independently. + +For agent `1.0.0-beta.3`, use core `1.0.0-beta.2`: + +```bash +sourceant setup --agent-version 1.0.0-beta.3 --core-version 1.0.0-beta.2 +``` + +The agent checks whether the core is running, but does not enforce a version range.