Skip to content

Commit a9fac84

Browse files
authored
Better docs intro text for Raven.js (#775)
1 parent 168b13d commit a9fac84

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

docs/index.rst

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,28 @@
1010
JavaScript
1111
==========
1212

13-
Raven.js is a tiny standalone JavaScript client for Sentry. It can be
14-
used to report errors from a web browser. The quality of reporting will
15-
heavily depend on the environment the data is submitted from.
13+
Raven.js is the official browser JavaScript client for Sentry. It automatically reports uncaught JavaScript exceptions
14+
triggered from a browser environment, and provides a rich API for reporting your own errors.
1615

17-
**Note**: If you're using Node on the server, you'll need
18-
`raven-node <https://github.com/getsentry/raven-node>`_.
16+
**Note**: If you're using Node.js on the server, you'll need
17+
`raven-node <https://docs.sentry.io/clients/node/>`_.
1918

2019
Installation
2120
------------
2221

23-
Raven.js is distributed in a few different methods, and should get
24-
included after any other libraries are included, but before your own
25-
scripts. For all details see :doc:`install`.
22+
The easiest way to load Raven.js is to load it directly from our CDN. This script tag should
23+
be included after other libraries are loaded, but before your main application code (e.g. app.js):
2624

2725
.. sourcecode:: html
2826

2927
<script src="https://cdn.ravenjs.com/3.8.1/raven.min.js"></script>
3028

29+
For installation using npm or other package managers, see :doc:`install`.
3130

3231
Configuring the Client
3332
----------------------
3433

35-
Now you need to set up Raven.js to use your `Sentry DSN
34+
Next you need to configure Raven.js to use your `Sentry DSN
3635
<https://docs.sentry.io/hosted/quickstart/#configure-the-dsn>`_:
3736

3837
.. code-block:: javascript
@@ -42,10 +41,10 @@ Now you need to set up Raven.js to use your `Sentry DSN
4241
At this point, Raven is ready to capture any uncaught exception.
4342

4443
Once you have Raven up and running, it is highly recommended to check out :doc:`config`
45-
and :doc:`usage` to improve your results.
44+
and :doc:`usage`.
4645

47-
Reporting Errors
48-
----------------
46+
Manually Reporting Errors
47+
-------------------------
4948

5049
By default, Raven makes a best effort to capture any uncaught exception.
5150

0 commit comments

Comments
 (0)