Skip to content

Add docs generator and initial generated documentation#228

Merged
thelovekesh merged 54 commits into
mainfrom
add/docgen
May 22, 2026
Merged

Add docs generator and initial generated documentation#228
thelovekesh merged 54 commits into
mainfrom
add/docgen

Conversation

@thelovekesh

Copy link
Copy Markdown
Collaborator
  • Add script to generate docs from commands tree.
  • Add docs for wpm cli
  • Add guides
  • Add script to generate docs in various formats

@github-actions

Copy link
Copy Markdown

📦 wpm cli builds 📦

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a comprehensive documentation suite for the wpm CLI, covering installation, getting started guides, fundamental concepts, and detailed command references. It also includes a new docgen tool and supporting scripts to automate the generation of Markdown, Man pages, and YAML documentation directly from the command tree. Feedback from the review highlights the need for stricter validation of the --format flag in the docgen tool, a correction regarding default indentation in the manifest documentation to match the examples, and the removal of hardcoded absolute paths from auto-generated CLI references.

Comment thread cmd/docgen/docgen.go
Comment thread docs/fundamentals/wpm-json.md
Comment thread docs/reference/cli/wpm.md Outdated
@thelovekesh thelovekesh changed the title Add docsgen and docs Add docs generator and initial generated documentation May 22, 2026
@thelovekesh thelovekesh merged commit cf95ef7 into main May 22, 2026
17 checks passed
@thelovekesh thelovekesh deleted the add/docgen branch May 22, 2026 14:49
@thelovekesh thelovekesh added the documentation Improvements or additions to documentation label May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant