Skip to content

docs: generate docs for all CLI commands#55

Merged
jaxxstorm merged 7 commits intomainfrom
docs
Feb 24, 2026
Merged

docs: generate docs for all CLI commands#55
jaxxstorm merged 7 commits intomainfrom
docs

Conversation

@jaxxstorm
Copy link
Copy Markdown
Owner

Signed-off-by: Lee Briggs lee@leebriggs.co.uk

Signed-off-by: Lee Briggs <lee@leebriggs.co.uk>
Copilot AI review requested due to automatic review settings February 24, 2026 21:41
Signed-off-by: Lee Briggs <lee@leebriggs.co.uk>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request introduces comprehensive documentation infrastructure for the tscli CLI tool by adding a Docsify-based documentation site with automated command reference generation from Cobra metadata.

Changes:

  • Adds Docsify documentation site with automated command reference generation from Cobra
  • Implements docs-generate, docs-check, and docs-serve Make targets
  • Integrates documentation verification into CI pipeline to prevent stale docs

Reviewed changes

Copilot reviewed 133 out of 135 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
test/docs/docs_test.go Tests verifying required documentation files exist and contain expected markers
openspec/changes/docsify-docs-and-command-markdown/* Comprehensive OpenSpec documentation including proposal, design, specs, and completed tasks
coverage/docsgen/main.go Documentation generator implementing generate and check modes with proper cleanup and error handling
docs/index.html Docsify entrypoint with Vue theme and custom configuration
docs/getting-started.md User-facing getting started guide with installation and first commands
docs/configuration.md Configuration documentation covering keys, profiles, and precedence
docs/authentication.md API key authentication methods and security guidance
docs/command-reference.md Index page explaining command reference structure and regeneration workflow
docs/commands/* 109 generated command reference pages with usage, flags, and cross-references
README.md Updated with documentation section, quick start examples, and common workflows
Makefile New targets for docs-generate, docs-check, and docs-serve
.github/workflows/ci.yml Added docs-check step to verify generated docs stay current
go.mod, go.sum Added transitive dependencies for Cobra markdown generation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Lee Briggs <lee@leebriggs.co.uk>
Signed-off-by: Lee Briggs <lee@leebriggs.co.uk>
Signed-off-by: Lee Briggs <lee@leebriggs.co.uk>
Signed-off-by: Lee Briggs <lee@leebriggs.co.uk>
Signed-off-by: Lee Briggs <lee@leebriggs.co.uk>
@jaxxstorm jaxxstorm merged commit 7bf9134 into main Feb 24, 2026
1 check 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.

2 participants