Skip to content

docs: Move versioning guidance out of the readme #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nfebe merged 1 commit into from
Sep 8, 2026
Merged

docs: Move versioning guidance out of the readme #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
View file
Open in desktop
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

@sourceant-local sourceant-local Bot Sep 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For stability and security, it's a best practice to pin GitHub Actions to a specific commit SHA or a release tag rather than a floating branch like main. This ensures that your workflow doesn't unexpectedly break or introduce vulnerabilities if the main branch of docs-kit changes.

Suggested change
- uses: whilesmart/docs-kit/.github/actions/validate-docs@main
- uses: whilesmart/docs-kit/.github/actions/validate-docs@<COMMIT_SHA_OR_TAG>

10 changes: 0 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,3 @@ make build
## Licence

MIT.

## Versioning

The CLI is versioned independently of the core, agent, and design package. A CLI release does not require matching releases of the components it installs. Use `--core-version` and `--agent-version` to select them separately, or `--image` and `--from` to choose the core directly.

CLI `1.0.0-beta.3` requires agent `1.0.0-beta.3` for `sourceant stop`. The agent defines core compatibility. For a reproducible setup, select both explicitly:

```bash
sourceant setup --agent-version 1.0.0-beta.3 --core-version 1.0.0-beta.2
```
14 changes: 14 additions & 0 deletions docs.json
View file
Open in desktop
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 CLI",
"description": "Install and control the local SourceAnt stack.",
"category": {
"language": "go"
},
"sidebar": [
{
"title": "Versions",
"path": "docs/versioning.md"
}
]
}
13 changes: 13 additions & 0 deletions docs/versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Versions

The CLI, agent, and core are versioned independently.

Select the agent and core releases during setup:

```bash

@sourceant-local sourceant-local Bot Sep 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using generic placeholders like X.Y.Z or MAJOR.MINOR.PATCH in documentation examples helps prevent them from becoming outdated quickly and clearly indicates that users should substitute their desired versions. Specific beta versions can be used to show a real-world example, but a more generic approach is often better for sustained relevance.

Suggested change
```bash
```bash
sourceant setup --agent-version <AGENT_VERSION> --core-version <CORE_VERSION>

sourceant setup --agent-version 1.0.0-beta.3 --core-version 1.0.0-beta.2
```

Use `--image` for a specific core container or `--from` for a Python installation source.

CLI `1.0.0-beta.3` needs agent `1.0.0-beta.3` for `sourceant stop`. The agent defines core compatibility.

@sourceant-local sourceant-local Bot Sep 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The statement "CLI 1.0.0-beta.3 needs agent 1.0.0-beta.3 for sourceant stop" could be clarified. If this is a specific compatibility note for these beta versions, it should be stated explicitly. If it represents a general pattern of CLI-agent interaction for stop functionality, it might be better phrased to reflect that general rule, perhaps using placeholders or a more abstract description of the dependency.

Suggested change
CLI `1.0.0-beta.3` needs agent `1.0.0-beta.3` for `sourceant stop`. The agent defines core compatibility.
CLI `1.0.0-beta.3` specifically requires agent `1.0.0-beta.3` for `sourceant stop` functionality due to new features/changes. The agent version defines core compatibility.

Loading