Skip to content

Commit 8ee1855

Browse files
HazATHazAT
committed
meta: Update docs
1 parent 05872a7 commit 8ee1855

File tree

3 files changed

+121
-7
lines changed

3 files changed

+121
-7
lines changed

‎assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎globals.html

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,85 @@ <h1> Sentry JavaScript SDKs</h1>
5959
<div class="container container-main">
6060
<div class="row">
6161
<div class="col-8 col-content">
62+
<section class="tsd-panel-group tsd-index-group">
63+
<h2>Index</h2>
64+
<section class="tsd-panel tsd-index-panel">
65+
<div class="tsd-index-content">
66+
<section class="tsd-index-section ">
67+
<h3>External modules</h3>
68+
<ul class="tsd-index-list">
69+
<li class="tsd-kind-external-module"><a href="modules/browser.html" class="tsd-kind-icon">browser</a></li>
70+
<li class="tsd-kind-external-module"><a href="modules/core.html" class="tsd-kind-icon">core</a></li>
71+
<li class="tsd-kind-external-module"><a href="modules/hub.html" class="tsd-kind-icon">hub</a></li>
72+
<li class="tsd-kind-external-module"><a href="modules/integrations.html" class="tsd-kind-icon">integrations</a></li>
73+
<li class="tsd-kind-external-module"><a href="modules/minimal.html" class="tsd-kind-icon">minimal</a></li>
74+
<li class="tsd-kind-external-module"><a href="modules/node.html" class="tsd-kind-icon">node</a></li>
75+
<li class="tsd-kind-external-module"><a href="modules/types.html" class="tsd-kind-icon">types</a></li>
76+
<li class="tsd-kind-external-module"><a href="modules/utils.html" class="tsd-kind-icon">utils</a></li>
77+
</ul>
78+
</section>
79+
</div>
80+
</section>
81+
</section>
6282
</div>
6383
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
6484
<nav class="tsd-navigation primary">
6585
<ul>
6686
<li class="globals current ">
6787
<a href="globals.html"><em>Globals</em></a>
6888
</li>
89+
<li class=" tsd-kind-external-module">
90+
<a href="modules/browser.html">browser</a>
91+
</li>
92+
<li class=" tsd-kind-external-module">
93+
<a href="modules/core.html">core</a>
94+
</li>
95+
<li class=" tsd-kind-external-module">
96+
<a href="modules/hub.html">hub</a>
97+
</li>
98+
<li class=" tsd-kind-external-module">
99+
<a href="modules/integrations.html">integrations</a>
100+
</li>
101+
<li class=" tsd-kind-external-module">
102+
<a href="modules/minimal.html">minimal</a>
103+
</li>
104+
<li class=" tsd-kind-external-module">
105+
<a href="modules/node.html">node</a>
106+
</li>
107+
<li class=" tsd-kind-external-module">
108+
<a href="modules/types.html">types</a>
109+
</li>
110+
<li class=" tsd-kind-external-module">
111+
<a href="modules/utils.html">utils</a>
112+
</li>
69113
</ul>
70114
</nav>
71115
<nav class="tsd-navigation secondary menu-sticky">
72116
<ul class="before-current">
117+
<li class=" tsd-kind-external-module">
118+
<a href="modules/browser.html" class="tsd-kind-icon">browser</a>
119+
</li>
120+
<li class=" tsd-kind-external-module">
121+
<a href="modules/core.html" class="tsd-kind-icon">core</a>
122+
</li>
123+
<li class=" tsd-kind-external-module">
124+
<a href="modules/hub.html" class="tsd-kind-icon">hub</a>
125+
</li>
126+
<li class=" tsd-kind-external-module">
127+
<a href="modules/integrations.html" class="tsd-kind-icon">integrations</a>
128+
</li>
129+
<li class=" tsd-kind-external-module">
130+
<a href="modules/minimal.html" class="tsd-kind-icon">minimal</a>
131+
</li>
132+
<li class=" tsd-kind-external-module">
133+
<a href="modules/node.html" class="tsd-kind-icon">node</a>
134+
</li>
135+
<li class=" tsd-kind-external-module">
136+
<a href="modules/types.html" class="tsd-kind-icon">types</a>
137+
</li>
138+
<li class=" tsd-kind-external-module">
139+
<a href="modules/utils.html" class="tsd-kind-icon">utils</a>
140+
</li>
73141
</ul>
74142
</nav>
75143
</div>

‎index.html

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -89,10 +89,6 @@ <h2 id="supported-platforms">Supported Platforms</h2>
8989
<p>For each major JavaScript platform, there is a specific high-level SDK that provides all the tools you need in a single
9090
package. Please refer to the README and instructions of those SDKs for more detailed information:</p>
9191
<ul>
92-
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/hub"><code>@sentry/hub</code></a>: Global state management of
93-
SDKs</li>
94-
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/minimal"><code>@sentry/minimal</code></a>: Minimal SDK for
95-
library authors to add Sentry support</li>
9692
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/browser"><code>@sentry/browser</code></a>: SDK for Browsers,
9793
including integrations for React, Angular, Ember, Vue and Backbone</li>
9894
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/node"><code>@sentry/node</code></a>: SDK for Node, including
@@ -127,12 +123,14 @@ <h2 id="other-packages">Other Packages</h2>
127123
development. If you&#39;re thinking about contributing to or creating a JavaScript-based SDK, have a look at the resources
128124
below:</p>
129125
<ul>
126+
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/hub"><code>@sentry/hub</code></a>: Global state management of
127+
SDKs</li>
128+
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/minimal"><code>@sentry/minimal</code></a>: Minimal SDK for
129+
library authors to add Sentry support</li>
130130
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/core"><code>@sentry/core</code></a>: The base for all
131131
JavaScript SDKs with interfaces, type definitions and base classes.</li>
132132
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/utils"><code>@sentry/utils</code></a>: A set of helpers and
133133
utility functions useful for various SDKs.</li>
134-
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/opentracing"><code>@sentry/opentracing</code></a>: OpenTracing
135-
compatible integration that can be used as a pluggable integration for the SDKs.</li>
136134
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/typescript"><code>@sentry/typescript</code></a>: Shared
137135
Typescript compiler and linter options.</li>
138136
<li><a href="https://github.com/getsentry/sentry-javascript/tree/master/packages/types"><code>@sentry/types</code></a>: Types used in all
@@ -146,10 +144,58 @@ <h2 id="other-packages">Other Packages</h2>
146144
<li class="globals ">
147145
<a href="globals.html"><em>Globals</em></a>
148146
</li>
147+
<li class=" tsd-kind-external-module">
148+
<a href="modules/browser.html">browser</a>
149+
</li>
150+
<li class=" tsd-kind-external-module">
151+
<a href="modules/core.html">core</a>
152+
</li>
153+
<li class=" tsd-kind-external-module">
154+
<a href="modules/hub.html">hub</a>
155+
</li>
156+
<li class=" tsd-kind-external-module">
157+
<a href="modules/integrations.html">integrations</a>
158+
</li>
159+
<li class=" tsd-kind-external-module">
160+
<a href="modules/minimal.html">minimal</a>
161+
</li>
162+
<li class=" tsd-kind-external-module">
163+
<a href="modules/node.html">node</a>
164+
</li>
165+
<li class=" tsd-kind-external-module">
166+
<a href="modules/types.html">types</a>
167+
</li>
168+
<li class=" tsd-kind-external-module">
169+
<a href="modules/utils.html">utils</a>
170+
</li>
149171
</ul>
150172
</nav>
151173
<nav class="tsd-navigation secondary menu-sticky">
152174
<ul class="before-current">
175+
<li class=" tsd-kind-external-module">
176+
<a href="modules/browser.html" class="tsd-kind-icon">browser</a>
177+
</li>
178+
<li class=" tsd-kind-external-module">
179+
<a href="modules/core.html" class="tsd-kind-icon">core</a>
180+
</li>
181+
<li class=" tsd-kind-external-module">
182+
<a href="modules/hub.html" class="tsd-kind-icon">hub</a>
183+
</li>
184+
<li class=" tsd-kind-external-module">
185+
<a href="modules/integrations.html" class="tsd-kind-icon">integrations</a>
186+
</li>
187+
<li class=" tsd-kind-external-module">
188+
<a href="modules/minimal.html" class="tsd-kind-icon">minimal</a>
189+
</li>
190+
<li class=" tsd-kind-external-module">
191+
<a href="modules/node.html" class="tsd-kind-icon">node</a>
192+
</li>
193+
<li class=" tsd-kind-external-module">
194+
<a href="modules/types.html" class="tsd-kind-icon">types</a>
195+
</li>
196+
<li class=" tsd-kind-external-module">
197+
<a href="modules/utils.html" class="tsd-kind-icon">utils</a>
198+
</li>
153199
</ul>
154200
</nav>
155201
</div>

0 commit comments

Comments
 (0)