warp icon indicating copy to clipboard operation
warp copied to clipboard

Cleanup README - discord link, installation instructions, FAQ

Open JorikSchellekens opened this issue 2 years ago • 18 comments

I think this would encourage people to join the conversation earlier.

Also, we have two discords. Should we pick one and close the other to keep the conversation in one place?

The file paths for the Cairo files are still using the old format

JorikSchellekens avatar Jan 14 '23 11:01 JorikSchellekens

Adding to ^, we should cleanup and link to other files instead of cramming everything in one file. Installation instructions can have a seperate file, contribution section can have its own file and same for testing. We should also add a FAQ section, which links to questions on newton.

If you're taking up this issue, please comment some more ideas which you think make the README more README-able!

swapnilraj avatar Jan 20 '23 09:01 swapnilraj

Hey, I would like to take up this issue. I also think we should add an introduction at the beginning and then create separate files as @swapnilraj mentioned.

coeuskoalemoss avatar Jan 22 '23 07:01 coeuskoalemoss

@coeuskoalemoss I've assigned you, btw I think this will be quite an iterative PR so heads for many comments coming your way and thanks for taking it up!

swapnilraj avatar Jan 22 '23 07:01 swapnilraj

hey thanks @swapnilraj, will we be communicating on here or is there any other channel?

coeuskoalemoss avatar Jan 22 '23 15:01 coeuskoalemoss

hey thanks @swapnilraj, will we be communicating on here or is there any other channel?

Hey @coeuskoalemoss I think the PR comments would be the best place.

swapnilraj avatar Jan 22 '23 16:01 swapnilraj

@coeuskoalemoss could you, as part of this task, move the documentation section to a place where it is easier to find, perhaps the intro section, or one with useful links.

rodrigo-pino avatar Jan 23 '23 14:01 rodrigo-pino

image Would be nice to add links to discord and twitter like this!

JorikSchellekens avatar Jan 27 '23 17:01 JorikSchellekens

@coeuskoalemoss are you working on this? Would you like to get on a call to discuss this further?

swapnilraj avatar Jan 28 '23 13:01 swapnilraj

hey @swapnilraj yes, so sorry was MIA for the past few weeks. Let's get on a call and discuss

coeuskoalemoss avatar Feb 04 '23 10:02 coeuskoalemoss

Hey @coeuskoalemoss can you a book a slot in my calendar from

["https://", "calendly.com/", "swp0x0/", "30min"].join("")

swapnilraj avatar Feb 06 '23 00:02 swapnilraj

hey @swapnilraj this link is not usable, can you send another one?

coeuskoalemoss avatar Feb 06 '23 13:02 coeuskoalemoss

@coeuskoalemoss its a bit of js code, did you try running it? It will produce the link, I don't want crawlers to get the link

swapnilraj avatar Feb 06 '23 13:02 swapnilraj

lol, I didn't know this was a thing. Done

coeuskoalemoss avatar Feb 06 '23 13:02 coeuskoalemoss

@coeuskoalemoss, do you need any more pointers on this?

swapnilraj avatar Feb 16 '23 17:02 swapnilraj

@swapnilraj no, its just my exams right now, so couldn't finish working

coeuskoalemoss avatar Feb 17 '23 05:02 coeuskoalemoss

hey @swapnilraj , have separated files and added badges to the readme. Sorry for taking so long.

Also, can you tell me more about the FAQs? you said we can add links to questions on newton, I'm not really familiar with newton.

coeuskoalemoss avatar Mar 12 '23 19:03 coeuskoalemoss

https://www.newton.so/view/638f52ba2de92baeb73b8d03 https://www.newton.so/view/63909cc6312738340469c247 https://www.newton.so/view/6390a0ed96b8a0cf52af8a62 https://www.newton.so/view/63bb4af84c2a049df8a6a1ec https://www.newton.so/view/63bb60dada90dae425befa80

Can you make a FAQ section with these questions and links to the answers on newton

swapnilraj avatar Mar 16 '23 15:03 swapnilraj

@coeuskoalemoss ^

swapnilraj avatar Mar 16 '23 15:03 swapnilraj