Skip to content

Conversation

@aryanjassal
Copy link
Contributor

@aryanjassal aryanjassal commented Dec 17, 2024

Description

There has been a lot of changes since the documentation was last changed, especially in the secrets domain. This PR focuses on bringing the documentation up to date, allowing for newer users to refer to the documentation and be confident about the accuracy.

This problem first occurred when I wanted my friend to try out Polykey, but they found the lack of documentation frustrating and kept having to ask me how Polykey works. This PR should bring the documentation up to date, making it easier for new users to start using Polykey.

Issues Fixed

Tasks

  • 1. Update polykey secrets
  • 2. Update polykey vaults
  • 3. Improve the quick start guide This is in a different PR and work for this should be done there instead
  • 3. Go through the code and update sections as needed

Final checklist

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

@linear
Copy link

linear bot commented Dec 17, 2024

@CMCDragonkai
Copy link
Member

Docs changes are something I want you to merge quickly to avoid things going out of date. You should not bother to wait for review.

@aryanjassal
Copy link
Contributor Author

I am not waiting for a review on this. I am just not done with this yet. I will merge this as soon as I am done working on this PR and the tasks are all completed.

@aryanjassal
Copy link
Contributor Author

The current state of the documentation is lagging behind the current feature set of Polykey pretty significantly. I probably won't be able to cover everything in this PR. I'll get this merged then work on updating the documentation whenever I have some free time.

I'll also have to review #101 and finish its tasks if it is close to completion.

@CMCDragonkai
Copy link
Member

I am not waiting for a review on this. I am just not done with this yet. I will merge this as soon as I am done working on this PR and the tasks are all completed.

Yes merge quickly and merge often. Docs is not code - there is no quality review just yet. We just iterate fast and don't leave content hanging.

@aryanjassal
Copy link
Contributor Author

I'm adding a $ before all the commands in triple backticks to denote that the command should be run on a console. This also enables us to differentiate between a console command and the output it generates.

chore: updated vaults commands

chore: updated grammar
@aryanjassal
Copy link
Contributor Author

I'll be merging this now as I have updated the information in here to better match the current status of Polykey CLI. I will keep the documentation up to date as I work on more commands. For now, if the CI passes, this PR can be merged.

@aryanjassal aryanjassal merged commit 9d37134 into staging Jan 14, 2025
7 checks passed
@CMCDragonkai
Copy link
Member

What conditions would lead to #95 being closed?

@aryanjassal
Copy link
Contributor Author

I haven't gone through the requirements properly yet, as the issue itself seems unspecced. I will need a bit of time to properly go through the issue, flesh out its specifications, then start work on its implementation. For now, however, I am focusing on critical polykey bug fixing.

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.

3 participants