torch-dataframe icon indicating copy to clipboard operation
torch-dataframe copied to clipboard

Published 20 hours ago • verified publisher icon AlexMili

Improved manual

Open gforge opened this issue 9 years ago • 3 comments

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.

gforge avatar Apr 25 '16 07:04 gforge

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.

AlexMili avatar Apr 25 '16 13:04 AlexMili

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

gforge avatar Apr 26 '16 09:04 gforge

For now the regular Github WIKI will be fine.

AlexMili avatar Apr 26 '16 09:04 AlexMili