docs: add Generating keys.json section to README - #473
Open
lzhao8956-glitch wants to merge 1 commit into
Open
Conversation
Closes valory-xyz#236 Adds a brief "Generating keys.json" subsection to "Set up your environment" that: - References the official Open Autonomy docs walkthrough - Shows the 3 command-line steps to generate a keys.json locally - Reminds developers that keys.json is gitignored and must never be committed This addresses the confusion reported in valory-xyz#236 where the keys.json file is required by the mech deployment CLI but its format is not documented in this README.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #236
Adds a brief "Generating keys.json" subsection under "Set up your environment" to document how local mech deployment users should create the required keys.json file.
Currently the README tells users to run
autonomy packages syncandmech run, but the prerequisite keys.json file (required by the deployment CLI) is not mentioned anywhere — leaving users to hunt through the Open Autonomy docs to figure it out, as reported in #236.Changes
Files changed