docs icon indicating copy to clipboard operation
docs copied to clipboard

Short examples in the docs

Open teevik opened this issue 6 years ago • 2 comments

The idea is from http://reddit.com/r/typescript/comments/b2hz2r/marblejs_functional_reactive_http_framework_built/eit5agg

So what we could do is to have a section in the docs where each page would be a small example on a specific topic. Some examples could be

  • Hello world
  • Routing
  • Combining routes
  • Context
  • Authentication

teevik avatar Mar 18 '19 18:03 teevik

Hi @teevik!

Thank you for pointing out this thread. 💪 Yeah, I know that the docs are not perfect and that's why I really appreciate this feedback.

Do you have any examples of how can we improve it? Eg. do you think that each „chapter” should have at the end some small example that summarizes it or each chapter should be built upon the example, eg. like Angular does it with Tour of Heroes?

JozefFlakus avatar Mar 18 '19 18:03 JozefFlakus

I was thinking more of just a list of small examples. Something similar to what typeorm does here: https://github.com/typeorm/typeorm/tree/master/sample . Typeorm has a few files for each example, but for marble.js it might work to have a single file for each example

Also doesn't necessarily need to be in the docs, could just be files github like at typeorm

teevik avatar Mar 18 '19 19:03 teevik