Skip to content

docs: Move versioning guidance out of the readme - #6

Merged
nfebe merged 1 commit into
mainfrom
docs/move-versioning-guidance
Sep 8, 2026
Merged

docs: Move versioning guidance out of the readme#6
nfebe merged 1 commit into
mainfrom
docs/move-versioning-guidance

Conversation

@nfebe

@nfebe nfebe commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

Keep version selection and compatibility guidance in the documentation using docs-kit.

@sourceant-local

Copy link
Copy Markdown

Code Review Summary

This pull request successfully moves versioning guidance from the README.md to a dedicated docs/versioning.md file, improving the overall documentation structure. A new GitHub Actions workflow is introduced to validate the documentation using docs-kit, and docs.json is added to configure the documentation build.

🚀 Key Improvements

  • Improved documentation structure by moving versioning guidance out of README.md into docs/versioning.md.
  • Introduction of docs.json for structured documentation configuration.

💡 Minor Suggestions

  • Pin the validate-docs GitHub Action to a specific commit SHA or release tag for better stability and security.
  • Clarify the version dependency statement in docs/versioning.md to be more general or specific about its context.
  • Consider using generic version placeholders in code examples within docs/versioning.md to prevent quick obsolescence.

@sourceant-local sourceant-local Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review complete. See the overview comment for a summary.

runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: whilesmart/docs-kit/.github/actions/validate-docs@main

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>

Comment thread docs/versioning.md

Select the agent and core releases during setup:

```bash

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>

Comment thread docs/versioning.md

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.

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.

@nfebe
nfebe merged commit c6e80b0 into main Sep 8, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant