Repository navigation
docs(readme): split the README into docs/ and lead with what stackctl is for - #185
Merged
Merged
Conversation
… is for The README had 867 lines; 460 of them were command examples that repeat --help. It never said that stackctl needs a K8s Stack Manager server, and its strongest points (no cluster credentials, scripting, the agent guide, plugins) were spread over the page. - README (112 lines): what stackctl is and that it needs a server, five highlights, Homebrew and the install script, a quick start that ends with port-forward and exec, AI agents and scripts, plugins, a documentation map, License. - docs/installation.md: all install methods (moved word for word). - docs/configuration.md: contexts, authentication, precedence (moved). - docs/commands.md: the examples of every command group, the command reference, output formats, confirmations, global flags, completion (moved). - docs/server-versions.md: short rows plus notes on older servers; the applies_to row now says v0.15.0 (was "the release after v0.14.0"). - CONTRIBUTING.md: the Contributing section (moved). - assets/*.svg: regenerated with freeze from stackctl 0.10.0, so the images show agent-guide, exec and port-forward. - CLAUDE.md: the new files in the project structure. The #installation anchor that k8s-stack-manager links to stays. Co-Authored-By: Claude Opus 5.5 <[email protected]>
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
 |
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.
Why
The README had 867 lines. About 460 of them were command examples that repeat
--help. It never said that stackctl needs a K8s Stack Manager server, and its strongest points were spread over the page: no cluster credentials, scripting, the agent guide and plugins. The terminal images were from March and didn't showagent-guide,execorport-forward.What changes
README.md (111 lines):
make demoin k8s-stack-manager), and five highlights#installationanchor that k8s-stack-manager's Getting Started links to stays.stack pods,stack port-forwardandstack execEXTENDING.md#what-plugins-receive. The note that built-in commands win on name collisions stays.New files. Sections moved word for word unless noted:
docs/installation.mddocs/configuration.mddocs/commands.mddocs/server-versions.mdapplies_torow now says v0.15.0, where it said "the release after v0.14.0".CONTRIBUTING.mdAlso:
assets/stackctl-help.svgandassets/stackctl-stack.svg: regenerated withfreeze(Dracula theme, as before) from stackctl 0.10.0.CLAUDE.md: the new files in the project structure, and the reference to where the docs mention terminal escape sequences.Checks
EXTENDING.md), and two old headings.go test ./cmd/ -run TestAgentGuidepasses.🤖 Generated with Claude Code