redditflow

redditflow copied to clipboard

Hey @abhijithneilabraham , what kind of help is wanted here with the docs?

Jul 08 '22 12:07 vxhl

Hello @vxhl ! Thanks for reaching out! As for documentation, we would love to have a Developer Documentation and a User documentation to demonstrate the features.

I would list out the topics I want to demonstrate in the developer documentation, and let you know soon!

Jul 11 '22 19:07 abhijithneilabraham

Ok then, i will work on the User Docs in the meanwhile

Jul 11 '22 20:07 vxhl

@vxhl Wonderful! Could you maybe start with this ? https://github.com/nfflow/redditflow/issues/14

There is a notebook already for a showing how redditflow works with text: https://github.com/nfflow/redditflow/blob/main/examples/Getting_Started_with_Redditflow_(text).ipynb

Try to do the same for Image API as well.

Thank You!

Jul 11 '22 20:07 abhijithneilabraham

Ok so just to be clear, I should make the documentation for the text in the main readme.md file while referencing to https://github.com/nfflow/redditflow/blob/main/examples/Getting_Started_with_Redditflow_(text).ipynb And for the Image API part I have to do it on my own right?

Jul 12 '22 03:07 vxhl

Hi, I think for now, the first steps would be creating a Colab notebook as above for the Image API.

Jul 12 '22 04:07 ghost