feat: docs version 0.2.1#90
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Migration
Written for commit ebce66d. Summary will update on new commits.