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

Short examples in the docs #2

Open
teevik opened this issue Mar 18, 2019 · 2 comments
Open

Short examples in the docs #2

teevik opened this issue Mar 18, 2019 · 2 comments
Labels
enhancement New feature or request

Comments

@teevik
Copy link

teevik commented Mar 18, 2019

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
@JozefFlakus
Copy link
Member

JozefFlakus commented Mar 18, 2019

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?

@teevik
Copy link
Author

teevik commented Mar 18, 2019

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

@JozefFlakus JozefFlakus transferred this issue from marblejs/marble Apr 28, 2019
@JozefFlakus JozefFlakus added the enhancement New feature or request label Apr 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants