Skip to content

Conversation

@xrissoula
Copy link
Contributor

@xrissoula xrissoula commented Apr 11, 2025

Description

This PR revamps our docs landing page and updates the Getting Started section, addressing outdated content from previous PRs and issues. It reorganizes the documentation according to the Divio principles and merges or removes obsolete tutorial information. It also fixes the incorrectly named branch from PR #139. Key highlights include:

  • Rearranged sidebar structure for clearer navigation.
  • Revamped docs/README.md to serve as an effective landing page.
  • Cleaned up old tutorial docs (now integrated into reference or removed if obsolete).
  • Added new or revised instructions for setting up Polykey, connecting identities, creating vaults, and sharing secrets.

These changes incorporate feedback from the old PR and aim to provide a more streamlined, user-friendly introduction to Polykey.

Tasks

  • 1. Revamp docs landing page (home page) for clarity and engagement.
  • 2. Clean up & reorganize Getting-Started docs (installation, bootstrapping, identity claims, etc.)
  • 3. Move or delete outdated PK-CLI tutorial content (reference info now in the Polykey-CLI commands).
  • 4. Add missing instructions for vault creation, secret management, and sharing scenarios.
  • 5. Rearrange sidebar to reflect the new Divio-based structure.

Final checklist

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

@xrissoula xrissoula requested a review from aryanjassal April 11, 2025 05:55
@xrissoula xrissoula self-assigned this Apr 11, 2025
@aryanjassal
Copy link
Contributor

https://github.com/MatrixAI/Polykey-Docs/actions/runs/14396558038

The CI workflow is also broken in this repo @brynblack

@CMCDragonkai
Copy link
Member

It requires an environment setup. I told @brynblack to setup in each CI file. The CI files requires updates. See the commit on zeta.house and zeta-house-docs in the .github.

@xrissoula
Copy link
Contributor Author

Hey @aryanjassal I think I've corrected most of what was left, I think we're ready for merging.

@aryanjassal
Copy link
Contributor

aryanjassal commented Apr 14, 2025

https://github.com/MatrixAI/Polykey-Docs/actions/runs/14437524821/job/40481197774

Deployment is failing but the CI step marks it as completed @brynblack. I feel that it might be something to do with environment variables @CMCDragonkai.

@aryanjassal aryanjassal force-pushed the feature-polykey-cli-refresh branch from e475d06 to d07f2ee Compare April 14, 2025 05:36
@aryanjassal
Copy link
Contributor

All the tasks have been finished and this PR looks good to go. Merging.

@aryanjassal aryanjassal reopened this Apr 14, 2025
@aryanjassal aryanjassal merged commit 1f7d7ca into staging Apr 14, 2025
4 checks passed
@CMCDragonkai
Copy link
Member

Great!

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.

Polykey-Docs 1.0: Revamping the PK-CLI set-up Guide under Getting Started Category

5 participants