Conversation
Signed-off-by: Lee Briggs <lee@leebriggs.co.uk>
Signed-off-by: Lee Briggs <lee@leebriggs.co.uk>
Contributor
There was a problem hiding this comment.
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, anddocs-serveMake 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>
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.
Signed-off-by: Lee Briggs lee@leebriggs.co.uk