Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

It's not actually clear from the readme how to start using the book #63

Closed
sarahmeyer opened this issue Aug 3, 2018 · 2 comments
Closed

Comments

@sarahmeyer
Copy link
Contributor

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.

@fitzgen
Copy link
Member

fitzgen commented Aug 3, 2018

FWIW, we have the repo's website pointing to the hosted version on github pages.

Would you consider this resolved if we had a big link/section about reading the book at the top of the README as well?

@sarahmeyer
Copy link
Contributor Author

Yes, absolutely! I'm opening up a PR to do exactly that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants