Skip to content

Commit

Permalink
docs(readme): improve the readme to point to the new docs (#4126)
Browse files Browse the repository at this point in the history
  • Loading branch information
niklas-wortmann authored and benlesh committed Sep 10, 2018
1 parent 7a9ffb5 commit 6a475cc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
7 changes: 5 additions & 2 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# RxJS official docs at http://reactivex.io/rxjs/
# RxJS V5 official docs at http://reactivex.io/rxjs/manual/overview.html

These files are not meant for reading directly in GitHub, they are just source code for generating the official page. You should find the docs at http://reactivex.io/rxjs/, containing all the documentation.
These files are not meant for reading directly in GitHub, they are just source code for generating the official page. You should find the docs at http://reactivex.io/rxjs/manual/overview.html, containing all the documentation.
Be aware, navigating to http://reactivex.io/rxjs will redirect you directly to the new V6 docs at https://rxjs-dev.firebaseapp.com.

*EVERYTHING WITHIN THIS FOLDER IS RELATED TO RxJS 5 AND WILL NOT BE MAINTAINED. CHECK OUT THE [NEW DOCS](../docs_app/README.md)*
9 changes: 7 additions & 2 deletions docs_app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Here are the most important tasks you might need to use:
* `npm run e2e` - run all the e2e tests for the doc-viewer.

* `npm run docs` - generate all the docs from the source files.
* `npm run docs-watch` - watch the RxJS source and the docs files and run a short-circuited doc-gen for the docs that changed.
* `npm run docs-watch` - watch the RxJS source and the docs files and run a short-circuited doc-gen for the docs that changed (don't work properly at the moment).
* `npm run docs-lint` - check that the doc gen code follows our style rules.
* `npm run docs-test` - run the unit tests for the doc generation code.

Expand All @@ -44,7 +44,7 @@ Here are the most important tasks you might need to use:

## Using ServiceWorker locally

Since abb36e3cb, running `npm run start --prod` will no longer set up the ServiceWorker, which
Running `npm run start --prod` will no longer set up the ServiceWorker, which
would require manually running `npm run sw-manifest` and `npm run sw-copy` (something that is not possible
with webpack serving the files from memory).

Expand Down Expand Up @@ -125,3 +125,8 @@ be regenerated, the app will rebuild and the page will reload.

* If you get a build error complaining about examples or any other odd behavior, be sure to consult
the [Authors Style Guide](https://angular.io/guide/docs-style-guide).

## Disclaimer

Starting the new documentation, we worked closely together with the Angular team and therefore adapted their way of generating docs. This leads to the effect, that there may be some references to angular (e.g. variable names, file names ...). Don't be confused by this, this shouldn't bother you. Thanks to the Angular Team for their support.
Anyway RxJS will always be an independent project, which aims to work closely with other technologies and frameworks!

0 comments on commit 6a475cc

Please sign in to comment.