Skip to content

DRAFT: Documentation Refactor#917

Open
lucspec wants to merge 2 commits intoMic92:masterfrom
lucspec:master
Open

DRAFT: Documentation Refactor#917
lucspec wants to merge 2 commits intoMic92:masterfrom
lucspec:master

Conversation

@lucspec
Copy link
Copy Markdown

@lucspec lucspec commented Feb 27, 2026

Hi all,

First off -- thanks for all of your work on this! I've been glad to have a seamless secrets management system that "just works" with my nix configs.

I did found the documentation to be a little hard to follow and ended up writing the guide in this pull request to make things more intuitive for me. In broad strokes, the change is to go away from a mono-README and break out instructions into singularly focused docs/*.md guides.

  1. Add a flow chart to help people decide which keys they might want to use (opinionated in my draft, based on my path of least resistance -- happy to revise to fit the project!)
  2. Add a dedicated docs/HowTo_[key-type].md files
    • ssh-to-age
    • age
    • gpg
    • ssh-to-gpg
  3. Add docs/InDepthUsage.md -- catchall for all of the useful docs in the second half of the mono-README; likely should break out into separate files in the same spirit as one guide per key

Comment thread docs/HowTo_sshToAge.md
## 2. Derive an age key:

```bash
# Convert an ssh ed25519 key to an age key
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doesn't support ssh keys directly these days?

Copy link
Copy Markdown
Author

@lucspec lucspec Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 20 there is slightly altered from the current README.

I don't actually know the answer based on the current documentation, which is partly why I started this update 😄. I appreciate the engagement here and would be glad to update this section if it doesn't fully reflect what the project supports. Is converting to an ssh key to an age key not strictly required?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants