Skip to content

Commit

Permalink
docs(contribution): describe briefly new documentation (#3778)
Browse files Browse the repository at this point in the history
  • Loading branch information
niklas-wortmann authored and benlesh committed Jun 7, 2018
1 parent b3d0c91 commit e3c2d5c
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,12 @@ from the main (upstream) repository:
## Documentation
- Documentation of RxJs will be shortly inline and more detailed in [rxjs-docs](https://github.com/ReactiveX/rxjs-docs)
- The [Documentation Guidelines](https://github.com/ReactiveX/rxjs-docs/blob/master/DOCUMENTATION_GUIDELINES.md) will support you
- Please keep both documents up to date
- The documentation is auto-generated directly from the source code.
- In short: From the source code we generate JSON documents, describing each operator, function ... and render this JSON within an Angular application
- The folder `docs-app` contains everything you need for building and developing the docs
- the folder `doc` used to be the documentation, but should remain until all content is transfered.
- The [Documentation README](docs_app/README.md) will support you
- After a PR is merged to master the docs will be published to https://rxjs-dev.firebaseapp.com/
## Unit Tests
Expand Down

0 comments on commit e3c2d5c

Please sign in to comment.