Skip to content

Make everyday Mecatl workflows discoverable #2386

Open
1 of 8 issues completed
Open

Description

@danbarr

Problem

The public docs explain Mecatl's capabilities, but terminal users still have to translate feature descriptions, configuration examples, and command inventories into an everyday workflow. People need help answering questions such as "which model should do this job?", "how do I review a plan before implementation?", and "how do I continue this tomorrow?"

Track a focused set of task-oriented improvements for people using mecatui locally or connecting to a shared remote service. This builds on the existing reader journeys rather than reopening the completed documentation IA restructuring in #2135.

Navigation direction

Use a Workflows subsection under Use Mecatl as the starting proposal. These tasks serve the same audience as the existing terminal-client journey. Keep Capabilities as the canonical home for shared behavior and availability, Deploy and operate for service configuration, and Reference for exact contracts.

The navigation subissue should decide the smallest useful implementation: an outcome-oriented index linking existing pages, a sidebar subsection, or a combination. New content does not require a new page. Prefer improving an existing owner when it already answers the question, and preserve published URLs if pages are regrouped. Revisit a separate top-level journey only if the content acquires a distinct audience or cross-client purpose; page count alone is not sufficient.

Scope

  • Improve model-routing discoverability and practical examples on the existing page.
  • Explain planning, revision, approval, and implementation as one user workflow.
  • Show how to remember, inspect, correct, and forget project knowledge.
  • Improve guidance for continuing long-running work across sessions.
  • Show a complete recurring-task workflow from prompt to result and cancellation.
  • Help readers choose and use reusable guidance, commands, and specialists.
  • Include the delegation guide already tracked by Document common mecatui delegation workflows #1718 and implemented in PR docs: guide mecatui delegation workflows #2385.
  • Make the workflows discoverable within Use Mecatl.

Shared acceptance criteria

  • Readers can start from an outcome in Use Mecatl and reach the appropriate instructions without knowing the capability's internal name.
  • Each worked scenario has an actionable prompt or configuration, an observable success condition, and relevant stop, recovery, or correction guidance.
  • Local configuration ownership and remote-server policy/capability limits are explicit where they affect the task.
  • Shared semantics remain canonical in Capabilities; procedural pages link rather than clone them.
  • Documentation describes shipped behavior. Open product issues are identified as constraints, not silently assumed fixed.
  • Changes pass the documentation generation/link checks and site build required by the authoring contract. Documentation-only work does not require running the full local runtime suites; CI supplies those checks.

Suggested order

Start with model-routing entry points and the plan-to-implementation workflow. The remaining content issues can proceed independently. Refine the Workflows navigation as pages become available; do not make all content wait on a broad reorganization.

Tracking

See the native subissues and the checklist below.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions