Skip to content

feat: docs version 0.2.1#90

Merged
gummiorri merged 1 commit into
mainfrom
89-create-docs-for-release-v021
Feb 9, 2026
Merged

feat: docs version 0.2.1#90
gummiorri merged 1 commit into
mainfrom
89-create-docs-for-release-v021

Conversation

@gummiorri

@gummiorri gummiorri commented Feb 9, 2026

Copy link
Copy Markdown
Member

Summary by cubic

Updates CLI docs for the v0.2.1 release and adds a markdown translator to the docs generator. Completes the “create docs for release v0.2.1” task by documenting new commands and aligning examples/flags with current CLI behavior.

  • New Features

    • Added docs for new top-level command: daco describe.
    • Added product command group with version and upgrade subcommands.
    • Expanded ports translate formats to include dqx-yaml and markdown.
    • Registered markdown translator in gendocs; updated index to list new commands.
  • Migration

    • Removed output format flags and JSON/YAML examples from connections/ports list and describe.
    • ports translate: added --all; -n accepts comma-separated names; -o now sets output directory; removed -d.

Written for commit ebce66d. Summary will update on new commits.

@gummiorri gummiorri linked an issue Feb 9, 2026 that may be closed by this pull request

@giuseppegrieco giuseppegrieco left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 11 files

Architecture diagram
sequenceDiagram
    participant Dev as Developer / CI
    participant Gen as gendocs (Doc Generator)
    participant CLI as daco CLI (Cobra)
    participant Trans as Markdown Translator
    participant Spec as OpenDPI Specification
    participant FS as Local Filesystem (/docs)

    Note over Dev, FS: Documentation Generation Phase
    Dev->>Gen: Run documentation generator
    Gen->>Trans: NEW: Register markdown translator
    Gen->>CLI: Load command tree (Root, Ports, Connections)
    Gen->>CLI: NEW: Initialize 'describe' and 'product' command groups
    CLI-->>Gen: Command metadata & flag definitions
    Gen->>FS: NEW: Generate daco_describe.md & daco_product_*.md
    Gen->>FS: CHANGED: Update existing MD files (remove legacy -o/-d flags)

    Note over Dev, Spec: CLI Runtime Flow (v0.2.1 Changes)
    Dev->>CLI: daco ports translate --all --format markdown -o ./out
    CLI->>Spec: Parse Data Product metadata
    
    alt NEW: Port Translation Logic
        CLI->>CLI: CHANGED: Parse comma-separated names or --all flag
        CLI->>Trans: NEW: Convert schema to Markdown format
        Trans-->>CLI: Markdown string
        CLI->>FS: CHANGED: Write results to output directory (via -o)
    end

    Note over Dev, Spec: Product Metadata Management
    Dev->>CLI: NEW: daco product upgrade --bump minor
    CLI->>Spec: Read current OpenDPI version
    CLI->>CLI: Calculate next version (SemVer)
    CLI->>Spec: Update version field in spec file
    Spec-->>CLI: Success
    CLI-->>Dev: Print new version info
Loading

@gummiorri gummiorri merged commit 21ab3d6 into main Feb 9, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create docs for release v0.2.1

2 participants