Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revamp Documentation for Updated Unix Commands in Polykey CLI #95

Open
10 tasks
CryptoTotalWar opened this issue Jul 15, 2024 · 1 comment
Open
10 tasks

Revamp Documentation for Updated Unix Commands in Polykey CLI #95

CryptoTotalWar opened this issue Jul 15, 2024 · 1 comment
Assignees
@CryptoTotalWar
Labels
documentation Improvements or additions to documentation procedure Action that must be executed

Comments

@CryptoTotalWar
Copy link
Contributor

Description

This ticket is dedicated to updating the Polykey documentation to incorporate the newly integrated Unix-style commands within the pk secrets subsystem. The goal is to ensure that all instructional materials are up-to-date, reflecting the new command functionalities to enhance clarity and usability for end users.

Tasks and Notes

  • Determine Release Strategy:

    • Decide if the CLI updates will be released all at once or in phases.
    • Plan to start detailing and implementing documentation updates 2 weeks prior to the first release.

  • ** Implementation Task Tracking:**:

    • Create and maintain a checklist for updating various sections of the documentation to align with the CLI changes.

  • Set Up Test Environment (Optional): Establish a test environment that mirrors the new CLI version to allow for hands-on interaction and verification of documentation accuracy.

Placeholder for Detailed Documentation Updates

Overview of Documentation Areas Needing Updates:

  • Docs Home Page

  • Getting Started Sections

  • Reference Sections

  • How-To-Guides

  • Blog Posts

    • X

    • Y
@CryptoTotalWar CryptoTotalWar added documentation Improvements or additions to documentation procedure Action that must be executed labels Jul 15, 2024
@CryptoTotalWar CryptoTotalWar self-assigned this Jul 15, 2024
@linear Linear
Copy link

linear bot commented Jul 15, 2024

PRO-205 Revamp Documentation for Updated Unix Commands in Polykey CLI

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

@CryptoTotalWar CryptoTotalWar

Labels
documentation Improvements or additions to documentation procedure Action that must be executed
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CryptoTotalWar