Platform: Docs: Move example app into docs

Created on 20 Dec 2018  路  4Comments  路  Source: ngrx/platform

Create a page for the example app describing what it is and its important parts. Move the stanadlone application into the docs example applications. From there we can generate a live StackBlitz example.

Other information:

I would be willing to submit a PR for the docs :heart:

[ ] Yes (Assistance is provided if you need help submitting a pull request)
[ ] No

Accepting PRs Docs Example App community watch

Most helpful comment

Apologies for the delay. A description of the example app and what's in it would be a good start. I don't think we'll move it from where it is now. We'll take another look at the tooling in time so see if we can include snippets of it in the guide.

  1. You can create an example-app.md in this folder https://github.com/ngrx/platform/tree/master/projects/ngrx.io/content/guide
  2. No specific convention for branch names.
  3. Add a link at the bottom of the navigation.json here to point to it https://github.com/ngrx/platform/tree/master/projects/ngrx.io/content/guide

All 4 comments

I would like to create the description for the example app. I have some questions:
1.) Where should be the description located? Maybe here: https://github.com/ngrx/platform/blob/master/projects/example-app/README.md
2.) Do you have any branch name convention? maybe pr/description-example-app?

Apologies for the delay. A description of the example app and what's in it would be a good start. I don't think we'll move it from where it is now. We'll take another look at the tooling in time so see if we can include snippets of it in the guide.

  1. You can create an example-app.md in this folder https://github.com/ngrx/platform/tree/master/projects/ngrx.io/content/guide
  2. No specific convention for branch names.
  3. Add a link at the bottom of the navigation.json here to point to it https://github.com/ngrx/platform/tree/master/projects/ngrx.io/content/guide

Perfect, hopefully this weekend i will start:)

Not going to do this after all

Was this page helpful?
0 / 5 - 0 ratings

Related issues

shyamal890 picture shyamal890  路  3Comments

brandonroberts picture brandonroberts  路  3Comments

mappedinn picture mappedinn  路  3Comments

alvipeo picture alvipeo  路  3Comments

smorandi picture smorandi  路  3Comments