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.

Sign up for GitHub

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

Jump to bottom

Document concepts and the API #1

Open
jonkri opened this issue Jul 27, 2015 · 2 comments
Open

Document concepts and the API #1

jonkri opened this issue Jul 27, 2015 · 2 comments
Labels
0 - Backlog

Comments

@jonkri
Copy link
Member

jonkri commented Jul 27, 2015

We should make clear what is meant by concepts such as identity, peer, etc., give a short overview of the API, and provide a short description for each API call, signal, etc.

The README or wiki might be a good place to keep this information.
@sils
Copy link

sils commented Aug 17, 2015

I can recommend readthedocs.org for documentation hosting which looks a bit more user friendly and not-so-githubby.

@Philonous Philonous mentioned this issue Oct 27, 2015
Open
@jonkri
Copy link
Member Author

jonkri commented Oct 27, 2015

@sils1297: Thanks for the tip - we will take it into consideration. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
0 - Backlog
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@Philonous @jonkri @sils