stacks-core icon indicating copy to clipboard operation
stacks-core copied to clipboard

[signer] stacks-singer config options should be documented

Open wileyj opened this issue 1 year ago • 3 comments

I didn't see any standalone markdown or other type of text only doc in this repo. I do see the code comments - maybe for a first draft it's sufficient to just copy/paste ?

./docs seems like a good location.

wileyj avatar Mar 21 '24 14:03 wileyj

Just as a note, these fields are documented in the "how to run a signer" page.

hstove avatar Mar 21 '24 18:03 hstove

Just as a note, these fields are documented in the "how to run a signer" page.

I stumbled across the same thought -- it's just not so blatant for users when it's surrounded by a bunch of text. The explanations are good, but it's a lot to digest for a power-user just trying to get it to work and thus the config file definitions easily missed. A separate page focused soley on configuration (i.e. both signer + node) would be beneficial here, I think. Kind-of like cargo does.

cylewitruk avatar Mar 24 '24 19:03 cylewitruk

@wileyj , it sounds like you know what kind of format you'd like to see here, and I do think the actual config fields are documented enough that you should be able to copy/paste them into a section (in the docs site or in this repo) that makes sense to you. I'm going to assign this back to you, but feel free to push back if you think I'm not making sense.

hstove avatar May 31 '24 17:05 hstove