Skip to content

Conversation

@xrissoula
Copy link
Contributor

Description

This PR introduces a new CLI command reference index page (list-of-commands.md) under the polykey-cli documentation section. It provides a categorized overview of all available polykey commands, linking to their respective detailed documentation (to be created or expanded in follow-up PRs).

Issues Fixed

Tasks

  • 1. Create list-of-commands.md file in docs/Getting-Started/polykey-cli/
  • 2. Populate it with grouped CLI command references and internal links
  • 3. Link this document in the sidebar (pending or already done in a separate commit)

Final checklist

  • Domain specific tests
  • Full tests
  • Updated inline-comment documentation
  • Lint fixed
  • Squash and rebased
  • Sanity check the final build

@xrissoula xrissoula self-assigned this May 21, 2025
@xrissoula xrissoula closed this May 21, 2025
@xrissoula xrissoula deleted the docs/cli-command-reference-63 branch May 21, 2025 22:59
@tegefaulkes
Copy link
Contributor

@xrissoula if this is closed and no longer worked on can you leave a comment as to why?

@xrissoula
Copy link
Contributor Author

@tegefaulkes Hey Brian sorry about that, I have closed this because of an incorrectly named branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants