Revamp documentation for Vega CLI and workflows#48
Merged
Conversation
Updated all major documentation files to reflect the new Vega CLI naming, commands, and workflows. Added detailed instructions for installation, development setup, troubleshooting, cluster creation, management, and contribution guidelines. Improved clarity, structure, and completeness of docs to support new features and user onboarding.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates all major documentation files to reflect the rebranding from VDK to Vega CLI while maintaining VDK as the project name (Vega Development Kit). The documentation now provides comprehensive coverage of installation, cluster management, commands, troubleshooting, and contribution guidelines.
Changes:
- Updated CLI command references from
vdktovegaacross all documentation - Added detailed command reference with flag descriptions and examples
- Expanded troubleshooting guide with infrastructure-specific sections
- Improved getting started guide with Devbox quick start and manual installation options
- Enhanced development setup documentation with project structure and key technologies
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/usage/managing-clusters.md | Updated to use Vega CLI commands, added infrastructure management sections (registry, proxy, cloud-provider), and certificate update instructions |
| docs/usage/creating-clusters.md | Replaced VDK commands with Vega, added init workflow, detailed flag usage, and cluster creation process explanation |
| docs/usage/command-reference.md | Comprehensive rewrite documenting all Vega commands (init, create, remove, list, update) with flags, aliases, and examples |
| docs/installation/getting-started.md | Restructured with Devbox quick start, manual installation steps, environment configuration, and macOS certificate troubleshooting |
| docs/debugging/troubleshooting.md | Expanded with registry, reverse proxy, and certificate troubleshooting sections; updated issue reporting template |
| docs/contribution/guidelines.md | Added C# code style guidelines, testing instructions, and detailed bug reporting template |
| docs/contribution/development-setup.md | Updated for .NET/C# stack, added Devbox setup, project structure diagram, and key technologies list |
| ReadMe.md | Streamlined with Devbox quick start, configuration section, and documentation table; removed redundant sections |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
@copilot open a new pull request to apply changes based on the comments in this thread |
Contributor
Co-authored-by: ewassef <5826918+ewassef@users.noreply.github.com>
Fix documentation inconsistencies in Vega CLI terminology and branding
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.
Updated all major documentation files to reflect the new Vega CLI naming, commands, and workflows. Added detailed instructions for installation, development setup, troubleshooting, cluster creation, management, and contribution guidelines. Improved clarity, structure, and completeness of docs to support new features and user onboarding.