PK-Docs: Reference Category -> Polykey-CLI: Create directory for primary commands & sub-command mappings

[CryptoTotalWar]

Description

This ticket is dedicated to updating the Polykey documentation to accurately represent the latest functionalities of the PK-CLI, with a focus on detailed references for both primary and sub-commands. The objective is to provide users with clear, comprehensive information that aids in the effective use of the CLI.

Tasks and Notes

• Content Development:

  • Create detailed descriptions for each primary and sub-command, including syntax, options, and examples.
  • Ensure all command descriptions are current with the latest CLI version, including new features and changes.

• Documentation Structure Updates:

  • Update the polykey-cli reference container with new information and structural adjustments.
  • Revise the commands index page under the polykey-cli reference container.
  • Develop or update primary command index pages under the commands container. The primary commands include:
    • Bootstrap
    • Agent
    • Audit
    • Nodes
    • Secrets
    • Keys
    • Vaults
    • Identities
    • Notifications

• Implementation and Tracking:

  • Link to the Pull Request (PR) that will be created for the implementation of these updates for easy tracking and review.

[linear]

PRO-182 PK-Docs (reference/poykey-cli) Create directory for primary commands to have sub-command mappings

[CMCDragonkai]

It's just a matter of using index.md for the main command like agent/index.md then sub commands agent/start.md and agent/stop.md.

[CMCDragonkai]

Unless there's a PR here, this is in todo, not in-progress.

[CryptoTotalWar]

It's just a matter of using index.md for the main command like agent/index.md then sub commands agent/start.md and agent/stop.md.

Based on the feedback here:

• The intention with this ticket is to flesh out reference category documentation for the Polykey-CLI commands.

[x] Create a Polykey-CLI category container under the Reference Section. This already exists. https://polykey.com/docs/reference/polykey-cli/

The README for the Polykey-CLI only contains 1 card because theres 3 levels in this tree.

Polykey-CLI - Reference section Category Container

• Commands - This serves as a high-level overview "city map" of all the primary & sub-primary commands in Polykey-CLI.

• The README for the Commands page seems to be sufficient at the moment so revamping it isn't fully necessary but the index pages for each individual primary command is lacking!!! In the future, i'd like for the overview page of Polykey-CLI commands to serve more as a high-level overview where the individual index pages for each primary command breaks down into depth and detail.

• Need to spec out the requirements for the PR in which we will largely need to focus on providing detailed handwritten reference information for the polykey primary commands.

Each sub-command can have its own index page for breaking down further detail. I would like the card lists to be at the top of each primary command index page for easier navigation.

This ticket is perfect timing for cycle 10 because there's prior PK-CLI documentation in the tutorials section that needs to be migrated here. I can use this ticket for tracking the initial migration, page structure-set-up requirements, and proliferation of additional requirements.

1. first step is setting up the page strucute. ~ S
2. next is configuring the sidebars.ts ~ XS
3. migrating existing info from getting started to the relevant pages ~ M
4. fleshing out the rest of the info ~ L