docs icon indicating copy to clipboard operation
docs copied to clipboard

[Edit docs] Update signer quickstart to use "latest" versions

Open stacks-alex opened this issue 3 months ago • 8 comments

URL of the page to change: https://docs.stacks.co/guides-and-tutorials/running-a-signer/signer-quickstart

The signer quickstart page has hardlinks to specific versions of the node and signer and so get out of date (currently linking to 3.1.0.0.5) - they should be updated to use a latest tag so they do not have to be updated with new releases

stacks-alex avatar Oct 07 '25 15:10 stacks-alex

will tackle this

eric-stacks avatar Oct 08 '25 15:10 eric-stacks

Updated links, in the top Current Signer and Stacks Node Versions callout block, to always point towards the "latest" versions

eric-stacks avatar Oct 09 '25 12:10 eric-stacks

There's also cli commands throughout the page that are version hard linked

On Thu, Oct 9, 2025 at 6:48 AM, eric-stackslabs < @.*** > wrote:

eric-stackslabs left a comment (stacks-network/docs#1736) ( https://github.com/stacks-network/docs/issues/1736#issuecomment-3385713850 )

Updated links, in the top Current Signer and Stacks Node Versions callout block, to always point towards the "latest" versions

— Reply to this email directly, view it on GitHub ( https://github.com/stacks-network/docs/issues/1736#issuecomment-3385713850 ) , or unsubscribe ( https://github.com/notifications/unsubscribe-auth/BXQLVPOSRC27KIVS6JS6AB33WZKQFAVCNFSM6AAAAACIQ4E4SCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZTGOBVG4YTGOBVGA ). You are receiving this because you authored the thread. Message ID: <stacks-network/docs/issues/1736/3385713850 @ github. com>

stacks-alex avatar Oct 09 '25 12:10 stacks-alex

Temporarily i put a soft callout "warning" block indicating that those CLI commands may contain outdated versions and to always refer to the latest versions in the top.

I'll need to figure out a way to have those dynamically showing the latest versions but need to see who usually updates these guides to see if him/her has suggestions on this.

eric-stacks avatar Oct 09 '25 13:10 eric-stacks

@ECBSJ I think we missed one link on this page: "Official binaries are available from the Stacks Core releases page on Github. Each release includes pre-built binaries. Download the latest signer release ZIP file for your server’s architecture and decompress it. Inside of that folder is a stacks-signer binary."

Under Step 2.

Also for the CLI commands, most of those are just sample outputs so we can add a note in the comment in that sample code that the release number will be different.

But there is one, also under Step 2, that we should change. We can use the latest tag in the CLI command as well: https://github.com/stacks-network/stacks-core/releases/latest/download/linux-glibc-x64.zip.

Same thing under Step 3b

kenrogers avatar Oct 10 '25 17:10 kenrogers

"Download the latest signer release ZIP file for your server’s architecture and decompress it. Inside of that folder is a stacks-signer binary."

I removed the hardcoded link in this sentence since there is no available "latest" link for this. Instead I re-worded it to make it obvious that the signer release can be found in that same Stacks Core release page, which is linked in the sentence right before it:

"Official binaries are available from the Stacks Core releases page on Github. Each release includes pre-built binaries. The version of stacks-signer compatible with this release is included on the same release page. Download the latest signer release ZIP file for your server’s architecture and decompress it. Inside of that folder is a stacks-signer binary."

In addition to the soft callout "warning" block near the top of the page, i've inserted a comment in each CLI command example noting that the release number, if shown hardcoded in the example, may be outdated.

eric-stacks avatar Oct 11 '25 06:10 eric-stacks

We can use this link for the latest link for the signer release: https://github.com/stacks-network/stacks-core/releases/latest

kenrogers avatar Oct 13 '25 15:10 kenrogers

changes made in both the live docs and test docs

eric-stacks avatar Oct 13 '25 16:10 eric-stacks