DOCS: clean up consolidated CLI showcase bundle #4444

New issue

Open

opened 2026-04-08 12:43:29 +00:00 by HAL9000 · 0 comments

HAL9000 commented

2026-04-08 12:43:29 +00:00

Owner

Summary

Update the CLI showcase documentation set so that every example uses the agents entrypoint
Align the published prerequisites with the project-wide Python 3.13 minimum
Fix broken internal references and clarify the JSON envelope when command is blank

Details

Documentation reviewers flagged a few inconsistencies in the consolidated CLI showcase bundle:

Two guides (session-management-workflows.md and actor-management-workflow.md) still demonstrate commands as python -m cleveragents ..., while the rest of the docs and examples.json rely on the agents entrypoint.
Three guides reference "Python 3.12 or higher" even though pyproject.toml requires >=3.13.
server-and-a2a-integration.md links to a config-and-automation-profiles.md page that does not exist.
Multiple JSON envelope examples show "command": "" without explaining why it is empty.

These gaps need to be resolved so the consolidated showcase reads consistently and matches the published support matrix.

Acceptance Criteria

All CLI showcase examples demonstrate the agents executable instead of python -m cleveragents
Every prerequisite block reflects the Python 3.13 minimum
server-and-a2a-integration.md only references files that exist in the repo
The JSON envelope explanation covers the "empty command" scenario
The issue is closed by the consolidating PR with updated docs and metadata

## Summary - Update the CLI showcase documentation set so that every example uses the `agents` entrypoint - Align the published prerequisites with the project-wide Python 3.13 minimum - Fix broken internal references and clarify the JSON envelope when `command` is blank ## Details Documentation reviewers flagged a few inconsistencies in the consolidated CLI showcase bundle: - Two guides (`session-management-workflows.md` and `actor-management-workflow.md`) still demonstrate commands as `python -m cleveragents ...`, while the rest of the docs and `examples.json` rely on the `agents` entrypoint. - Three guides reference "Python 3.12 or higher" even though `pyproject.toml` requires `>=3.13`. - `server-and-a2a-integration.md` links to a `config-and-automation-profiles.md` page that does not exist. - Multiple JSON envelope examples show `"command": ""` without explaining why it is empty. These gaps need to be resolved so the consolidated showcase reads consistently and matches the published support matrix. ## Acceptance Criteria - [ ] All CLI showcase examples demonstrate the `agents` executable instead of `python -m cleveragents` - [ ] Every prerequisite block reflects the Python 3.13 minimum - [ ] `server-and-a2a-integration.md` only references files that exist in the repo - [ ] The JSON envelope explanation covers the "empty command" scenario - [ ] The issue is closed by the consolidating PR with updated docs and metadata

Rows
Columns