Skip to content
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

Add Ruby-RNP documentation and link #2

Open
ronaldtse opened this issue May 2, 2018 · 1 comment
Open

Add Ruby-RNP documentation and link #2

ronaldtse opened this issue May 2, 2018 · 1 comment
Assignees

Comments

@ronaldtse
Copy link
Contributor

ronaldtse commented May 2, 2018

Ruby-RNP: https://github.com/riboseinc/ruby-rnp

Ruby-RNP documentation: https://www.rubydoc.info/github/riboseinc/ruby-rnp/master/toplevel

Mentioned here: rnpgp/ruby-rnp#6 (comment)

@strogonoff
Copy link
Contributor

strogonoff commented Sep 9, 2018

The Ruby-RNP docs is just an API reference. As theme docs point out (and I believe) it’s best to instead link to RubyDoc API reference.

However, what we would want to do additionally (if the goal is to promote the project in the industry) is to provide docs that Ruby-RNP is currently much lacking, namely an overview, a getting started guide and a couple of typical usage tutorials.

In this ticket I’m adding the link to Ruby-RNP and creating the foundation for further docs, for now based on README, later adding sample I’m putting together for the post in #10. These new docs would be placed into ruby-rnp repo’s docs/ directory, and subsequently get picked up during rnpgp.com build.

@strogonoff strogonoff self-assigned this Sep 9, 2018
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

No branches or pull requests

2 participants