search

rnpgp / rnpgp.github.io

Official RNP site
https://www.rnpgp.com
1 stars 3 forks source link

Add pages with man pages for the rnp, rnpkeys and librnp. #28

Closed ni4 closed 3 years ago

ni4 commented 3 years ago

As now we have manuals in .adoc format, we should add those to the site as well, so search requests like rnp generate key or rnp encrypt will land on a friendly-looking page.

strogonoff commented 3 years ago

Software with properly defined metadata (see Open Project theme docs) is supposed to have its docs built into part of the site, actually. Filed https://github.com/rnpgp/rnpgp.org/issues/33 (this may be closed in favor of that, I presume) and am looking into what’s going wrong on CI.

ni4 commented 3 years ago

@strogonoff I'm not that familiar with Open Project theme yet, but as I see now at the site, it just picks up .adoc files from the docs folder. However in this issue I mean inclusion of src/rnp/rnp.1.adoc, src/rnpkeys/rnpkeys.1.adoc and src/lib/librnp.3.adoc.

strogonoff commented 3 years ago

Understood. Yes, it doesn’t handle that yet. It’s not terribly complicated to add, but I’m not sure yet whether this should be implemented in an abstract way (after all, it’s just a set of adoc files in another directory than docs/), or support for specifically man page rendering should be added…

On 6 Apr 2021, at 11:11 PM, Nickolay Olshevsky @.***> wrote:

@strogonoff https://github.com/strogonoff I'm not that familiar with Open Project theme yet, but as I see now at the site, it just picks up .adoc files from the docs folder. However in this issue I mean inclusion of src/rnp/rnp.1.adoc, src/rnpkeys/rnpkeys.1.adoc and src/lib/librnp.3.adoc.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rnpgp/rnpgp.org/issues/28#issuecomment-814152867, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACHQX3QFGGJTAFLRKKBFLDTHMJABANCNFSM4YTER7HA.