sciencefair icon indicating copy to clipboard operation
sciencefair copied to clipboard

Published 20 hours ago • verified publisher icon sciencefair-land

[req] Add User Docs

Open VickyRampin opened this issue 7 years ago • 7 comments

I think it would be great if you added a "getting started" guide and as sciencefair evolves, lengthy documentation for users -- although probably you'd want both. I feel like it would benefit users to see a narrative of how to start. Even just a few sentences well publicized on the websites in the spirit of this:

When you download sciencefair, you'll be able to search XYZ corpus of text, download articles (in bulk!), and read and tag them. Here's how that looks!

Followed by a bit of text and images from screenshots in this repo.

In this version it might not be the most necessary (but would be a good addition, in my view), but should definitely add it for version 1.1.

VickyRampin avatar Jun 29 '17 12:06 VickyRampin

Thanks @VickySteeves - I agree. Do you think this could be served by something as simple as a walkthrough gif? Or do you think we need something more explicit that people can use at their own pace?

blahah avatar Jun 29 '17 14:06 blahah

I think letting users go at their own pace with gifs is good :wink: but in all seriousness, right now just a short paragraph and a gif/your screenshots would do!

I forked the repo and am working on it.

VickyRampin avatar Jun 29 '17 14:06 VickyRampin

@VickySteeves shout if I can help point you in the right direction. We also have a chat room if you have any questions. I'm saying this because I'm acutely aware that the site setup is not friendly for new contributors and I would be amazed if anyone can just jump in and contribute to it without any docs!

blahah avatar Jun 29 '17 16:06 blahah

The hardest part honestly is making the gifs! This is what I have so far:

screenshot from 2017-06-29 15-57-21

I'm going to add some text either below or above those images (gifs), fix the text under the large heading and make a PR!

VickyRampin avatar Jun 29 '17 19:06 VickyRampin

Whoa, this is spectacularly awesome @VickySteeves!! Thank you so much 😃

Let me know if I can do anything to help, but that looks like a really excellent addition (i tried making gifs a bunch of times and could never get it right)!

blahah avatar Jun 29 '17 20:06 blahah

Ok, the gifs are kinda big but everything is functional/done -- making my PR!

VickyRampin avatar Jun 29 '17 21:06 VickyRampin

@VickySteeves to reduce gif size you can upload to giphy then download smaller size which they autoconvert :)

blahah avatar Jun 29 '17 21:06 blahah