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

Improved manual #15

Open
gforge opened this issue Apr 25, 2016 · 3 comments
Open

Improved manual #15

gforge opened this issue Apr 25, 2016 · 3 comments
Assignees
@gforge
Labels
enhancement help wanted

Comments

@gforge
Copy link
Collaborator

gforge commented Apr 25, 2016

The README is currently lagging. We need to cover:

  • batch functionality
  • exemplify how to set up a network using the dataframe
  • the basic statistics available

... and more. I'm not sure if it's best to build a larger README or if we should start a doc-folder. Anyway the README requires a TOC to start with.
@AlexMili
Copy link
Owner

You're right, we can't let the README get bigger and bigger. I think we should keep the "doc" term (and directory) for the API documentation and use the WIKI for tutorials, examples, etc.

@gforge
Copy link
Collaborator Author

gforge commented Apr 26, 2016

Sounds good. Do we have the WIKI outside the project or is the WIKI handled using regular PRs?

@AlexMili
Copy link
Owner

For now the regular Github WIKI will be fine.

@gforge gforge self-assigned this May 3, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gforge gforge

Labels
enhancement help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gforge @AlexMili