docs: Move versioning guidance out of the readme - #6
Conversation
Code Review SummaryThis pull request successfully moves versioning guidance from the 🚀 Key Improvements
💡 Minor Suggestions
|
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: whilesmart/docs-kit/.github/actions/validate-docs@main |
There was a problem hiding this comment.
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.
| - uses: whilesmart/docs-kit/.github/actions/validate-docs@main | |
| - uses: whilesmart/docs-kit/.github/actions/validate-docs@<COMMIT_SHA_OR_TAG> |
|
|
||
| Select the agent and core releases during setup: | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
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.
| ```bash | |
| ```bash | |
| sourceant setup --agent-version <AGENT_VERSION> --core-version <CORE_VERSION> |
|
|
||
| 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. |
There was a problem hiding this comment.
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.
| 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. |
Keep version selection and compatibility guidance in the documentation using docs-kit.