warp
warp copied to clipboard
Cleanup README - discord link, installation instructions, FAQ
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
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!
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 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!
hey thanks @swapnilraj, will we be communicating on here or is there any other channel?
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.
@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.
Would be nice to add links to discord and twitter like this!
@coeuskoalemoss are you working on this? Would you like to get on a call to discuss this further?
hey @swapnilraj yes, so sorry was MIA for the past few weeks. Let's get on a call and discuss
Hey @coeuskoalemoss can you a book a slot in my calendar from
["https://", "calendly.com/", "swp0x0/", "30min"].join("")
hey @swapnilraj this link is not usable, can you send another one?
@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
lol, I didn't know this was a thing. Done
@coeuskoalemoss, do you need any more pointers on this?
@swapnilraj no, its just my exams right now, so couldn't finish working
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.
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
@coeuskoalemoss ^