Polykey-Docs: Getting Started Tutorials - 1.0 Update

[CryptoTotalWar]

Goals and Objectives

The main objective of this Epic is to overhaul the "Getting Started" tutorials for Polykey to make them intuitive, practical, and reliable, ensuring they are perfectly aligned with Divio’s documentation system principles. The tutorials will be designed to take a user from novice to proficient user, demonstrating core functionalities through a hands-on, step-by-step approach that ensures the user achieves meaningful outcomes.

Tutorial Structure and Content

Each tutorial will focus on concrete tasks that build towards a significant, achievable goal. The structure will minimize theoretical explanations and instead concentrate on actionable steps.

Tasks & Notes

---

Home Page

• The home page has been moved under the getting started sidebars category as the first sidebar item

• Create ticket to track development and deliberation

• The purpose of the sidebar navigation is to serve as an intuitive-self-sufficient-self-explainable overview of the polykey documentation. That being said, what do we want the entry page of the pk docs to cover? Other website use it as card list for their entire documentation… some use it as a 1st stop getting started guide.
  • I would think that maybe this could be a page that we use for breaking down the functionality, capabilities, and technology of Polykey and a mention of all the things it can do for you, whether thats with the CLI on your machine, on a hosted env, integrating the client libraryin a project, etc…
    • This version is a bit hard, would require quite a lot more work, discussion, deliberation, etc.
  • So the question i have for this now, is as part of quick revamp of our getting started structure, what should we have here? what should we include?
    • The entry page is being rendered regardless and currently its half baked and somewhat distracting
      • so first line of business is to work with our current state
        • remove unnecessary info & identify relevant info for the quick update
          • get feedback from the team
            • look at other website documentation entry pages for further inspiration
              • but keep in mind, at this iterative stage, I am just looking for a quick fix.
                • We can create a sub-ticket that will track the iterative release and deliberation of a better home page

---

Getting Started Category container

1. Set Up Polykey CLI on your Machine - Page

• Install Poykey-CLI - Section
  • detailed info for Windows install
  • Reference info for updates or deleting with npm
• Bootstrap your first PK Node - Section

2. Connecting idP - page

3. Sharing Vaults across different Nodes or identities

Option to do this with another user/identity or b/w 2 nodes you control.

NOTE

• It would be very beneficial to have asiinema for these tutorials
  • Requires a terminal configured for this.

Migrations of info

• There's a reference ticket related to pk cli commands. lets migrate some of the previous info in tutorials there to enhanec it.

Additional requirements

• Put a contribution guide somewhere and link that ticket here

[linear]

PRO-192 Polykey-Docs: TUTORIAL Docs 1.0 EPIC