feat: Docs for release v.0.2.1

[gummiorri]

Summary by cubic

Update docs for v0.2.1 to match the latest CLI and add markdown translation support. Adds new product and describe commands, updates translate behavior, and includes a sample OpenDPI spec.

• New Features

  • Register markdown translator and add "markdown" to translate formats.
  • New daco describe command for a product overview.
  • New daco product command with version and upgrade subcommands.
  • Translate supports multiple ports (--name a,b) and all ports (--all), with a single --output directory.
  • Add sample OpenDPI spec and schema with generated markdown (spec/, schemas/, daco.yaml).
  • Simplify connections/ports list and describe docs by removing JSON/YAML output examples.

• Migration

  • connections/ports list and describe: remove -o/--output (JSON/YAML). Default human-readable output only.
  • ports translate: replace --output-dir with --output (directory). Use --name for multiple ports or --all for all ports.
  • Add daco.yaml to point the CLI to your spec directory (path: ./spec).

^{Written for commit b1fc36f. Summary will update on new commits.}

[cubic-dev-ai]

1 issue found across 15 files

Prompt for AI agents (all issues)

Check if these issues are valid — if so, understand the root cause of each and fix them.


<file name="schemas/myport.md">

<violation number="1" location="schemas/myport.md:38">
P2: The "Fields" anchor is duplicated, so the Spec link points to the wrong section. Give the Fields type section a unique heading and update the link so readers land on the correct definition.</violation>
</file>

Architecture diagram

sequenceDiagram
    participant User
    participant CLI as daco CLI
    participant FS as Filesystem (daco.yaml / spec/)
    participant Registry as Translator Registry
    participant Trans as Markdown Translator
    participant Out as Output Directory

    Note over User,Out: Port Translation Flow (v0.2.1)

    User->>CLI: daco ports translate --all --format markdown --output ./docs
    
    CLI->>FS: NEW: Load daco.yaml for spec path
    FS-->>CLI: path: ./spec
    
    CLI->>FS: Load OpenDPI spec (opendpi.yaml)
    FS-->>CLI: Spec data (ports, metadata)
    
    alt NEW: Port Selection Strategy
        Note right of CLI: Logic for --all or --name a,b
        CLI->>CLI: Resolve list of target ports
    end

    CLI->>Registry: Get translator for "markdown"
    Registry-->>CLI: NEW: Markdown Translator instance

    loop For each resolved port
        CLI->>FS: Load port schema ($ref)
        FS-->>CLI: Schema definition
        
        CLI->>Trans: NEW: Translate(schema)
        Trans-->>CLI: Generated Markdown content
        
        CLI->>Out: CHANGED: Save to --output directory
    end

    CLI-->>User: Success message

    Note over User,FS: Product Metadata Flow (v0.2.1)

    User->>CLI: NEW: daco describe
    CLI->>FS: Load spec from configured path
    FS-->>CLI: Metadata, Ports, Connections
    CLI->>CLI: CHANGED: Format as human-readable table (no -o flag)
    CLI-->>User: Display product overview

    User->>CLI: NEW: daco product upgrade --bump minor
    CLI->>FS: Read current version from spec
    CLI->>CLI: Increment version (e.g. 1.0.0 -> 1.1.0)
    CLI->>FS: NEW: Write updated version to spec file
    CLI-->>User: Confirmation message

Loading

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

[cubic-dev-ai]

P2: The "Fields" anchor is duplicated, so the Spec link points to the wrong section. Give the Fields type section a unique heading and update the link so readers land on the correct definition.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At schemas/myport.md, line 38:

<comment>The "Fields" anchor is duplicated, so the Spec link points to the wrong section. Give the Fields type section a unique heading and update the link so readers land on the correct definition.</comment>

<file context>
@@ -0,0 +1,39 @@
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `fields` | array([Fields](#Fields)) | No |  |
+
</file context>