Skip to content

nsc: improve command documentation#1883

Open
hugosantos wants to merge 1 commit into
mainfrom
improve-nsc-command-docs
Open

nsc: improve command documentation#1883
hugosantos wants to merge 1 commit into
mainfrom
improve-nsc-command-docs

Conversation

@hugosantos

Copy link
Copy Markdown
Contributor

Summary

  • make nsc command summaries concise and action-oriented
  • standardize terminology, capitalization, grammar, and punctuation
  • add missing summaries for hidden command groups and correct misleading descriptions

Testing

  • go test ./cmd/nsc/... ./internal/cli/cmd/admin ./internal/cli/cmd/auth ./internal/cli/cmd/aws ./internal/cli/cmd/gcp ./internal/cli/cmd/cluster/... ./internal/cli/cmd/devbox ./internal/cli/cmd/integrations ./internal/cli/cmd/scratch ./internal/cli/cmd/sdk ./internal/cli/cmd/token ./internal/cli/cmd/vault ./internal/cli/cmd/version ./internal/cli/cmd/workspace
  • go run ./cmd/nsc/gendoc /tmp/nscdocs
  • git diff --check

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant