PK-Docs: Getting Started | Home | PK-CLI | Docs 1.0 revamp PR #101
Conversation
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
…ntial to add for it, we should not have it in the deployed docs because it just serves as a distraction atm
CryptoTotalWar
added
the
documentation
Improve the getting started section for setting up Polykey: - Updated instructions for installing PK-CLI. - Added detailed steps for bootstrapping the first node. - Included screenshots for better visual guidance. - Added inline notes, warnings, and tips to enhance user understanding. - Ensured consistent terminology and clear explanations throughout the guide.
…ntainer and update sidebar configuration
…syntax highlighting
25 tasks
… and explain --node-path usage
Contributor
|
I might take over this too |
10 tasks
xrissoula
reviewed
Mar 27, 2025
| # Set-Up Polykey on your Machine | ||
|
|
||
| Installing the CLI can be done in different ways depending on your operating environment. | ||
| :::note |
11 tasks
Member
|
Closed in favor of #139. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Issues Fixed
Tasks
1. add sidebar for docs homepage
2. edit docs homepage for engagement and effective overview of the docs
3. flesh out / update a finalized version of the polykey-set-up page for installing and bootstrapping
4. flesh out / update a finalized version for connecting to an IDP
Need a section first where we have them create a vault, create a dummy secret, add it to the vault, and then get it in the terminal. This will be the same vault they share with the other node.
5. flesh out / finalize a PK demo that follows the demo tutorial but requires bootstrapping / managing a second node locally, alternatively, they can find another dev to perform the demo with... Ideal.
6. clean up getting-started docs, the previous documentation should be synthesized in reference guide documentation
Final checklist