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
17 changes: 17 additions & 0 deletions .github/workflows/validate-docs.yml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
14 changes: 14 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
@@ -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"
}
]
}
11 changes: 11 additions & 0 deletions docs/versioning.md
Original file line number Diff line number Diff line change
@@ -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.
Loading