MoralisWeb3 / issue-tracker

25 stars 7 forks source link

Documentation assumes too much prior knowledge #19

Closed SimonJamesOdell closed 3 years ago

SimonJamesOdell commented 3 years ago

Hi guys, as requested over on discord here is a summary of the feedback I offered regarding the documenation.

I suggest adding a section entitled something like "Prerequisite Knowledge" which gives a breif overview of how you expect Moralis to be used and what technologies are needed / recommended to be used with it, along with some links to further reading. The information can probably safely assume the reader has a firm understanding on a modern javascript stack, but should not assume they are familiar with the cryptosphere technologies.

jermay commented 3 years ago

This is a great suggestion. I've added an intro section and will go through the Web3 stuff and add more introductory comments... any other specific suggestions you have would be very helpful.

https://docs.moralis.io/#welcome-to-moralis-beta

gerardo15 commented 3 years ago

Great! @jermay i have also added a Pre-Requisites tab on the docs

https://docs.moralis.io/pre-requisites

@SimonJamesOdell let us know if we could add something more or we are missing something!

Thanks for taking your time for this!

SimonJamesOdell commented 3 years ago

I'm guessing English is not your first language, if you want I can help by doing a pull request with some improvements to grammar and some further additions like links on the pre-requisites page.

gerardo15 commented 3 years ago

@SimonJamesOdell Amazing!

I added the file to this repo so you can pull-request:

https://github.com/MoralisWeb3/issue-tracker/blob/main/files/pre-requisites.md

jermay commented 3 years ago

I've made some edits for grammar, added links and a "Software" section.

How does this look now?

jermay commented 3 years ago

If there are additional suggestions please create another issue. Will close this one.