-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add comprehensive CLI documentation #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
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
- Comprehensive analysis of current auth methods and priority - Identified pain points in current setup flow - Proposed improvements including setup wizard and auth testing - Implementation plan with phased approach - Comparison with traditional curl approach Part of #33
- Add automated documentation generation script - Generate complete command reference for all CLI commands - Create extensive examples document with common workflows - Document authentication, database ops, clustering, backups, monitoring - Add troubleshooting guide and Docker usage examples - 46 reference docs + comprehensive examples guide
- Move all CLI reference documentation from docs/cli-reference to docs/src/cli-reference - Add comprehensive CLI Command Reference section to SUMMARY.md - Include profile, smart, cloud, and enterprise command documentation - Copy detailed examples and configuration audit to CLI usage section - Successfully tested mdBook build with new structure
- Add workflow to automatically build and deploy mdBook to GitHub Pages - Triggers on pushes to main branch when docs change - Includes mdbook-lint for quality checks on documentation - Configure book.toml with correct repository URLs and lint settings - Cache mdbook-lint installation for faster CI runs - Only deploys on main branch, builds on PRs for validation
- Remove configuration-audit.md as it was meant for internal planning - Update SUMMARY.md to remove reference - Keep CONFIGURATION_AUDIT.md in docs/ for internal reference
- Remove mdbook-lint preprocessor config to avoid false positives with $ in code blocks - Update GitHub Actions to run lint in informational mode - Fix broken link fragments in examples-detailed.md (remove & from anchors) - Simplify lint configuration for better compatibility
- Add .mdbook-lint.toml with proper configuration - Temporarily disable MDBOOK010 (math detection) and MDBOOK005 (orphaned files) until upstream issues #141 and #142 are resolved - Configure preprocessor correctly in book.toml - Simplify GitHub Actions workflow - lint now runs as part of build - Set line length to 120 chars for technical documentation - Configuration validated with 'mdbook-lint check' Thanks to @joshrotenberg for the quick feedback on proper configuration!
- Prevent CI failures due to lint errors during initial setup - MDBOOK010 errors still appearing despite being disabled (preprocessor may not be picking up config) - Many internal link validation errors need to be fixed separately
- Remove mdbook-lint as preprocessor due to configuration not being picked up - Run mdbook-lint as separate CLI step in GitHub Actions (informational only) - Add MDBOOK002 to disabled rules (false positives on existing files) - Set continue-on-error for lint step to prevent CI failures - mdBook now builds successfully without the preprocessor
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
This PR adds comprehensive CLI reference documentation for redisctl, integrates it into the mdBook documentation structure, and sets up automated deployment to GitHub Pages.
Changes
Documentation Added
46 CLI command reference files covering all commands:
Detailed examples guide (
docs/src/cli/examples-detailed.md) with real-world usage scenariosmdBook Integration
docs/src/cli-reference/for proper mdBook structuredocs/src/SUMMARY.mdbook.tomlwith correct repository URLs and titlemdbook buildGitHub Pages Deployment
.github/workflows/mdbook.yml) for automatic deploymentDocumentation Generation
scripts/generate-cli-docs.sh) for future documentation updatesDocumentation Structure
Testing
GitHub Pages Setup
Once merged, the documentation will be automatically deployed to GitHub Pages:
https://joshrotenberg.github.io/redisctl/Local Development
Related Issues
Addresses #34 - CLI documentation
Next Steps