Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Operator Guide to Reflect Use of Precompiled Binaries for Key Generation #312

Open
ImmaZoni opened this issue Nov 1, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@ImmaZoni
Copy link
Contributor

ImmaZoni commented Nov 1, 2023

Description:
The operator guide's command examples currently assume that users have built the software from source. This may not reflect the typical user's experience, as many will download and use precompiled binaries. To better serve this user base, it's crucial to update the command examples to reference precompiled binaries rather than source-compiled ones.

Current Command:

target/production/subspace-node key generate --scheme sr25519

Proposed Update:

.\subspace-node-windows-x86_64-skylake-gemini-3g-2023-oct-31.exe key generate --scheme sr25519

Additional Context:
The above example is just one instance. Many commands in the guide reference the target/production/subspace-node binary. It's imperative to review and update all such instances in the documentation to ensure consistency and accuracy.

Note: While the provided example is for the Windows binary, the idea applies universally. Updates should be considered for all platform-specific binaries in the guide.

Curious your thoughts @EmilFattakhov & @jim-counter

@ImmaZoni ImmaZoni added the enhancement New feature or request label Nov 1, 2023
@jim-counter
Copy link
Member

Sounds sensible to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants