Skip to content

docs: update prints in documentation - #1314

Merged
AlessandroPomponio merged 1 commit into
mainfrom
ap_20260730_update_doc_prints
Jul 31, 2026
Merged

docs: update prints in documentation#1314
AlessandroPomponio merged 1 commit into
mainfrom
ap_20260730_update_doc_prints

Conversation

@AlessandroPomponio

@AlessandroPomponio AlessandroPomponio commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

This PR refreshes the documentation to reflect the current state of the ado CLI and codebase. Terminal output blocks, command examples, and YAML snippets across several pages have been updated to match what users actually see when running ado today, replacing outdated content that no longer matched real CLI behaviour.

High-level Changes

  • CLI output blocks updated: Terminal and command output examples in the user guide and developer guide now show current ado CLI output, including updated column names, version numbers, and actuator/operator listings.
  • Commands updated to recommended forms: Documentation now consistently recommends the --details flag for ado get actuators and ado get experiments, and uses --use-latest in operator workflow steps.
  • YAML snippets replaced with live includes: Hardcoded YAML examples for pyproject.toml and sample store configuration are now included directly from their source files, keeping those documentation pages automatically in sync.
  • Formatting fixes: Various minor markdown formatting issues corrected, including admonition syntax, code block style directives, and list indentation.
  • ray-tune defaults updated: Default parameter values in the ray-tune operator documentation corrected to match current behaviour (NaN, null, bayesopt).

Impact

Documentation only — no source code or behaviour is changed. Users following the updated pages will now see commands and outputs that match the current version of ado.


AI Disclosure

The code and this PR description were generated using IBM Bob and reviewed manually.

Signed-off-by: Alessandro Pomponio <alessandro.pomponio1@ibm.com>
@AlessandroPomponio
AlessandroPomponio added this pull request to the merge queue Jul 31, 2026
Merged via the queue into main with commit 32b6970 Jul 31, 2026
18 checks passed
@AlessandroPomponio
AlessandroPomponio deleted the ap_20260730_update_doc_prints branch July 31, 2026 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Enables CI integration

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants