You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I was looking at /README.md and realized that I didn't actually know how to start using the book until I read through the whole documentation very carefully and realized that the quickest way to start reading it was to navigate to /src and start reading the markdown files.
Describe what about it does not make sense
The information about the easiest way to read the useful documentation and tutorials in the book should be the first thing in the README.md, which should be a document describing the project in this repo.
Why does it not make sense?
The vital information is at the end of the document in an aside.
How could we improve it?
Add a Getting Started section at the beginning that describes the things you can do with the book (read it, run examples from it, etc) and tells you how to do them.
The text was updated successfully, but these errors were encountered:
Where in the docs did you come across this?
I was looking at
/README.md
and realized that I didn't actually know how to start using the book until I read through the whole documentation very carefully and realized that the quickest way to start reading it was to navigate to/src
and start reading the markdown files.Describe what about it does not make sense
The information about the easiest way to read the useful documentation and tutorials in the book should be the first thing in the
README.md
, which should be a document describing the project in this repo.Why does it not make sense?
The vital information is at the end of the document in an aside.
How could we improve it?
Add a
Getting Started
section at the beginning that describes the things you can do with the book (read it, run examples from it, etc) and tells you how to do them.The text was updated successfully, but these errors were encountered: