react-tracking icon indicating copy to clipboard operation
react-tracking copied to clipboard

Published 20 hours ago • verified publisher icon nytimes

Docs website

Open tizmagik opened this issue 7 years ago • 19 comments

It would be nice to use gh-pages to put the documentation that's currently completely in the README in a nicer place

tizmagik avatar Sep 28 '17 18:09 tizmagik

you want it to be built in a specific template or hosting the present one directly with some intelligent tweaks will work?

GeekyShiva avatar Sep 28 '17 22:09 GeekyShiva

https://geekyshiva.github.io/react-tracking/

Check this base , do you need some tweaks or this works as this is a simple jeykell implemetation.

Please specify any requirements if you have

GeekyShiva avatar Sep 28 '17 22:09 GeekyShiva

Thanks @GeekyShiva that looks good! I would love something similar to https://react-styleguidist.js.org/ but I'm actually not sure what's involved with that. If you do, that would be great, otherwise it looks like what you have there would work well for now. Let me know, thanks!

tizmagik avatar Sep 28 '17 23:09 tizmagik

hey @tizmagik awesome that you liked the idea, I have something in mind which looks similar to the link that you showed and once Hacktober starts I will make a PR with required changes, will that be ok??

GeekyShiva avatar Sep 28 '17 23:09 GeekyShiva

Sounds great. Thank you 🙏

tizmagik avatar Sep 29 '17 00:09 tizmagik

hey, if you don't mind can you please assign this issue to me :)

GeekyShiva avatar Sep 29 '17 01:09 GeekyShiva

For some reason Github won't let me assign to you, but no worries, it's yours

tizmagik avatar Sep 29 '17 14:09 tizmagik

thanks :)

GeekyShiva avatar Sep 29 '17 17:09 GeekyShiva

hey @tizmagik , I have made a PR, please review it and merge as i need to check the final results also I have an idea for exactly what you want but need to make major changes in README.md and some other files.

Also take a look at this: http://vinitkumar.me/white-paper/

I can make this website look like the one you sent me with the above-mentioned changes, what are your thoughts?

GeekyShiva avatar Sep 30 '17 19:09 GeekyShiva

Thanks @GeekyShiva — happy to entertain changes to the README. Do you have a good idea of what would need changing? Happy to review a PR with those changes as well. Thanks!

tizmagik avatar Sep 30 '17 21:09 tizmagik

For starters, we have to change the way readme is arranged and make it more suitable as per the css of our new Jekyll theme.

Furthermore, we have to make all the typo theme changes in readme

Please review and accept this PR since as of now we can make things working and I can keep on experimenting with further changes

GeekyShiva avatar Sep 30 '17 21:09 GeekyShiva

@tizmagik have you reviewed the PR?

GeekyShiva avatar Oct 01 '17 06:10 GeekyShiva

Hi @GeekyShiva and @tizmagik is this issue still active? Does someone working on this? I want to help :)

jalalmanafi avatar Jan 07 '23 10:01 jalalmanafi

Please go for it @jalalbmnf ! Thank you ❤️

tizmagik avatar Jan 07 '23 12:01 tizmagik

@tizmagik We can use docusaurus library, also react-styleguidist using docusaurus. Is that okay?

jalalmanafi avatar Jan 08 '23 08:01 jalalmanafi

Yes docusaurus would be great, I’m a big fan of it!

tizmagik avatar Jan 08 '23 14:01 tizmagik

Okay, i will work on this issue

jalalmanafi avatar Jan 08 '23 14:01 jalalmanafi

@tizmagik I will create a website inside this repository, is this okay?

jalalmanafi avatar Jan 11 '23 13:01 jalalmanafi

Yes sounds good

tizmagik avatar Jan 12 '23 09:01 tizmagik