[DOCS] <Improve the documentation>

csdojo-defaang / defaang

A website that will curate recently-asked interview questions from FAANG+. Currently inactive. Check out: https://github.com/ykdojo/OpenStream

MIT License

509 stars 120 forks source link

Closed subhoghoshX closed 2 years ago

subhoghoshX commented 2 years ago

I think the doc can be improve in many ways.

Use semantic ordered list for the instructions, instead of #1 or #2
Remove the comments which are in parentheses. As, if you click on the copy button, they also get copied. Bad UX.
Add steps like cd <project-directory> to remove any confusion

For reference here's how tailwindcss.com does it.

It's simple & to the point. Any feedback is welcome.

subhoghoshX commented 2 years ago

I'd like to work on it. @ykdojo could you assign me this

ykdojo commented 2 years ago

It looks like it didn't show up on the commit history?

subhoghoshX commented 2 years ago

Yes, because I discarded the commit and closed the PR. I send another PR.