Add `sq` documentation for end users
So far sequoia has guides (https://docs.sequoia-pgp.org/sequoia_guide/) that seem intended for developers (not users) and does not include the tool.
The API (https://docs.sequoia-pgp.org/sequoia_core/index.html) if for developers and only include one sentence regarding the store.
And the --help
(https://gitlab.com/sequoia-pgp/sequoia/blob/master/tool/src/sq-usage.rs#L135) command does not explain for instance what is for store realm and name.
As a user, the first thing i had to know is that what we call tool
is sq
.
Regarding the store, it would be nice to clarify that the name is just a label for the realm, and why to use a realm. @nwalfield explained offline that the realm is to avoid colissions, but i don't see how org.sequoia-pgp.contacts
avoid collisions than using a domain name like contacts.sequoia-pgp.org
. Also, it's supposed that you use realms of domains that you administer, but there's no currently any way to verify that, maybe @teythoon has some plans on it.
I think is a common and nice approach in many projects to separate documentation for end users and developers. If you agree with it, i think i should open an issue on sequoia Web to add a section for users, other for developers and then point to correct places.
And of course, if you agree, i'd start trying to document the tool better.
I think this should be in milestone 1.0.