Skip to content

feat: add docs#72

Merged
gummiorri merged 5 commits intomainfrom
71-generate-docs-using-cobra
Jan 31, 2026
Merged

feat: add docs#72
gummiorri merged 5 commits intomainfrom
71-generate-docs-using-cobra

Conversation

@gummiorri
Copy link
Copy Markdown
Member

@gummiorri gummiorri commented Jan 31, 2026

Summary by cubic

Adds a Cobra-based docs generator and checks in LLM-friendly Markdown for the daco CLI under docs/cli. Improves command help text, adds doc-gen deps, and fixes spark-scala translator registration; fulfills “generate docs using Cobra” (Linear #71).

  • New Features

    • New command: cmd/gendocs generates Markdown docs (default output: ./docs/cli); run with go run ./cmd/gendocs [output-dir].
    • Added long descriptions for root, ports, and connections commands to improve generated docs.
    • Committed generated docs for daco, init, connections (add/describe/list/remove), and ports (add/describe/list/remove/translate).
  • Bug Fixes

    • Correctly wire spark-scala to sparkscala.Translator (was pointing to pyspark).
    • Fix ports translate help example to use --format gotypes instead of --format go.

Written for commit 66878be. Summary will update on new commits.

@gummiorri gummiorri linked an issue Jan 31, 2026 that may be closed by this pull request
@gummiorri
Copy link
Copy Markdown
Member Author

@cubic-dev-ai review this

@cubic-dev-ai
Copy link
Copy Markdown
Contributor

cubic-dev-ai Bot commented Jan 31, 2026

@cubic-dev-ai review this

@gummiorri I have started the AI code review. It will take a few minutes to complete.

Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

2 issues found across 17 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="cmd/gendocs/main.go">

<violation number="1" location="cmd/gendocs/main.go:48">
P2: The spark-scala format is wired to the PySpark translator, which will generate Python output in the docs for the Spark Scala format. Use the Spark Scala translator instead so the generated docs match the intended format.</violation>
</file>

<file name="docs/cli/daco_ports_translate.md">

<violation number="1" location="docs/cli/daco_ports_translate.md:25">
P3: The example uses `--format go`, but the documented valid formats list only includes `gotypes`. This makes the example misleading or invalid for users.</violation>
</file>

Since this is your first cubic review, here's how it works:

  • cubic automatically reviews your code and comments on bugs and improvements
  • Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
  • Ask questions if you need clarification on any suggestion

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

Comment thread cmd/gendocs/main.go Outdated
Comment thread docs/cli/daco_ports_translate.md Outdated
Copy link
Copy Markdown
Contributor

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

Choose a reason for hiding this comment

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

1 issue found across 17 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="docs/cli/daco_ports_translate.md">

<violation number="1" location="docs/cli/daco_ports_translate.md:25">
P3: Example uses `--format go`, but the documented valid formats list `gotypes` (and does not mention `go`). This makes the example misleading or invalid for users.</violation>
</file>

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

Comment thread docs/cli/daco_ports_translate.md Outdated
gummiorri and others added 4 commits January 31, 2026 12:14
Add cobra/doc-based markdown generator and enrich command descriptions
for better LLM consumption. Fix spark-scala translator wiring.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Comment thread cmd/daco/internal/app.go
Copy link
Copy Markdown
Member

@giuseppegrieco giuseppegrieco left a comment

Choose a reason for hiding this comment

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

LGTM

@giuseppegrieco giuseppegrieco linked an issue Jan 31, 2026 that may be closed by this pull request
@gummiorri gummiorri merged commit 4c0f06d into main Jan 31, 2026
9 checks passed
@gummiorri gummiorri deleted the 71-generate-docs-using-cobra branch January 31, 2026 19:45
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.

spark-scala registered with PySpark translator Generate docs using cobra

2 participants