Polykey-Docs Revamp PK-CLI Getting Started #90
Closed
Conversation
This file contains 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
- Removed Tutorials README from sidebar. - Renamed 'Tutorials' navbar to 'Getting Started'. - Reformatted Getting Started docs for PK-CLI. - Commented out Polykey-Mobile and Polykey-Desktop sections.
CryptoTotalWar
added
documentation
|
Abandoning this feature branch. Need to start from scratch. I am attempting to remove the READMe for tutorials and the PK-Mobile and PK-Dsktop sections and I keep getting errors on the server side build. |
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
This issue is restructuring the Tutorials section of the documentation to enhance DUX. These enhancements are based on observations made from developer documentation standards and practices. This is an iterative development that aims to streamline the PK-CLI getting started DUX. The expected outcome is to streamline the process of installation & bootstrapping. Additional considerations for streamlining and showcasing PK-CLI functionality includes connecting a node to an idp, and showcasing secrets management functionality.
Issues Fixed
Tasks
1. Reformatting NavBar
Removed Tutorials README from sidebar.
Renamed 'Tutorials' navbar to 'Getting Started'.
Reformatted Getting Started docs for PK-CLI.
Commented out Polykey-Mobile and Polykey-Desktop sections.
2. ...
3. ...
Final checklist