🧠 Improve CLI help output and documentation

[Copilot]

The CLI lacked meaningful --help output: no long descriptions, no examples, and the Python CLI was missing --config entirely (present in Rust).

Rust CLI (src/cli.rs)

• Added long_about with multi-line description (formats supported, toolchain)
• Build description: "Build the renderflow pipeline" → "Build rendered documents from a renderflow configuration file"
• after_help examples sections on both root and build subcommands
• value_name = "FILE" on --config for cleaner metavar

Python CLI (renderflow/cli.py)

• Added matching multi-line help to Typer app
• Added missing --config FILE option to build (now consistent with Rust)
• metavar="FILE" + show_default=True on --config

Before / After (renderflow --help):

# Before
Spec-driven document rendering engine
Usage: renderflow [OPTIONS] [INPUT] [COMMAND]
Commands:
  build  Build the renderflow pipeline

# After
renderflow — Spec-driven document rendering engine

Transform structured YAML configurations into rendered documents
(PDF, HTML, LaTeX) using Pandoc, Tectonic, and Jinja2 templates.

Usage: renderflow [OPTIONS] [INPUT] [COMMAND]
Commands:
  build  Build rendered documents from a renderflow configuration file
...
Examples:
  renderflow build                        Build using renderflow.yaml
  renderflow build --config custom.yaml   Build with a custom config file
  renderflow build --dry-run              Preview what would be built

Tests

• Added strip_ansi() helper to Python tests to handle Rich-colored help output
• New Python tests: root help content, build listing, --config/--dry-run presence, --config acceptance
• New Rust tests: --help exit code, description content, options and examples documented

Original prompt

---

This section details on the original issue you should resolve

<issue_title>🧠 Improve CLI help output and documentation</issue_title>
<issue_description>Title: 🧠 Improve CLI help output and documentation

---

Description

Refine CLI help output to clearly describe usage and commands.

---

Goals

• Improve discoverability
• Make CLI self-documenting

---

Requirements

• Add descriptions to:
  • CLI root
  • commands
  • arguments
• Ensure "--help" output is clean and helpful

---

Acceptance Criteria

• Help output is clear and readable
• Commands and flags documented
• UX feels intuitive</issue_description>

Comments on the Issue (you are @copilot in this section)

• Fixes 🧠 Improve CLI help output and documentation #33

---

💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.

[devactivity-app]

Pull Request Summary by devActivity

Metrics

Achievements

• @szmyty
  Earned XP: 15⭐
  Check Your Progress