Skip to content

docs: Add explanatory comments to CLI commands in signer guide - #1815

Closed
Earnwithalee7890 wants to merge 1 commit into
stacks-network:masterfrom
Earnwithalee7890:docs/improve-cli-examples
Closed

Earnwithalee7890 wants to merge 1 commit into
stacks-network:masterfrom
Earnwithalee7890:docs/improve-cli-examples

Conversation

@Earnwithalee7890

Copy link
Copy Markdown

Description

Added inline comments explaining CLI flags and options in the signer quickstart guide to help new operators understand command parameters.

Changes

  • ✅ Added explanation of --config flag for signer run command
  • ✅ Added note about foreground execution and systemd recommendation
  • ✅ Added detailed comments for all flags in generate-stacking-signature command
  • ✅ Explained what each parameter controls (auth-id, period, reward-cycle, etc.)

Why This Helps

New signer operators benefit from understanding what each CLI flag does without needing to reference separate documentation or man pages. This reduces setup errors and improves operator confidence.

@CLAassistant

CLAassistant commented Jan 30, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@friedger friedger left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this is nice to read, it makes copy and paste harder.
I suggest explaining the details in normal text, not in code

@wileyj wileyj closed this Mar 12, 2026
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.

4 participants