-
Notifications
You must be signed in to change notification settings - Fork 5
Updating documentation for polykey secrets commands
#112
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.
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
Conversation
|
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. |
|
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. |
|
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. |
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. |
|
I'm adding a |
chore: updated vaults commands chore: updated grammar
4451f08 to
d1ccacb
Compare
|
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. |
|
What conditions would lead to #95 being closed? |
|
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. |
Description
There has been a lot of changes since the documentation was last changed, especially in the
secretsdomain. 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
polykey secretspolykey vaults3. Improve the quick start guideThis is in a different PR and work for this should be done there insteadFinal checklist