docs: backfill missing CLI commands in cli-reference.md - #223
Open
ke23y wants to merge 1 commit into
Open
Conversation
cli-reference.md documented only 10 of the 16 top-level nightshift commands actually registered in cmd/nightshift/commands (root.go AddCommand calls). Add config (get/set/validate), init, install/uninstall, report, and busfactor to the Core Commands table and add new Config Commands, Project Setup Commands, and Reporting Commands sections, sourced from each command's actual Use/Short/Long and cobra flag definitions. Nightshift-Task: docs-backfill Nightshift-Ref: https://github.com/marcus/nightshift
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
1 participant
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
website/docs/cli-reference.mddocumented only 10 of the 16 top-levelnightshiftcommands actually registered incmd/nightshift/commands(per theAddCommandcalls inroot.go/each command file).config(get/set/validate),init,install/uninstall,report, andbusfactor— to the Core Commands table.## Config Commands,## Project Setup Commands, and## Reporting Commandssections with example usage and flag tables, sourced from each command's actualUse/Short/Longtext and cobra flag definitions in the corresponding.gofiles.docs/bus-factor.mdfor detailed bus-factor metric explanations, matching howbusfactoris already documented elsewhere (docs/bus-factor.md,website/docs/scheduling.md,troubleshooting.md).Test plan
cobra.CommandandFlags()definitions inconfig.go,init.go,install.go,report.go, andbusfactor.go.cli-reference.mdfor formatting consistency (tables, code blocks, headers) with existing sections.cd website && npm install && npm run build— not run in this environment (no network-fetchednode_modules); recommend running in CI before merge.🤖 Generated with Claude Code
Automated by nightshift