Skip to content

Commit 9ff9401

Browse files
committed
docs(User Interaction API): Restructure library documentation
1 parent daae9bb commit 9ff9401

25 files changed

+2005
-280
lines changed

package-lock.json

Lines changed: 39 additions & 39 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"eject": "react-scripts eject",
2929
"storybook": "start-storybook -p 6006 -s public",
3030
"build-storybook": "build-storybook -s public",
31-
"docs": "typedoc src/library/user-analytics --gitRevision develop --out ./public/docs",
31+
"docs": "typedoc src/library --gitRevision develop --out ./public/docs",
3232
"tsc": "tsc --project tsconfig.prod.json",
3333
"prepublish": "npm run tsc"
3434
},
@@ -66,6 +66,6 @@
6666
"@types/styled-components": "^5.1.8",
6767
"antd": "^4.12.3",
6868
"styled-components": "^5.2.1",
69-
"typedoc": "^0.20.32"
69+
"typedoc": "^0.21.2"
7070
}
7171
}

public/docs/assets/css/main.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
--color-panel-divider: #eee;
1111
--color-comment-tag: #707070;
1212
--color-comment-tag-text: #fff;
13-
--color-code-background: rgba(#000, 0.04);
13+
--color-code-background: rgba(0, 0, 0, 0.04);
1414
--color-ts: #9600ff;
1515
--color-ts-interface: #647f1b;
1616
--color-ts-enum: #937210;

public/docs/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.

public/docs/index.html

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -414,16 +414,25 @@ <h2>Check out the <a href="./docs">docs</a> folder for a complete list of API re
414414
<nav class="tsd-navigation primary">
415415
<ul>
416416
<li class=" ">
417-
<a href="modules.html">Exports</a>
417+
<a href="modules.html">Modules</a>
418418
</li>
419419
<li class=" tsd-kind-module">
420-
<a href="modules/lib_interaction_tracking_browser.html">lib/interaction-<wbr>tracking/browser</a>
420+
<a href="modules/browser_storage.html">browser/storage</a>
421421
</li>
422422
<li class=" tsd-kind-module">
423-
<a href="modules/lib_resources_baseresource.html">lib/resources/base<wbr>Resource</a>
423+
<a href="modules/browser_user_interaction.html">browser/user-<wbr>interaction</a>
424424
</li>
425425
<li class=" tsd-kind-module">
426-
<a href="modules/lib_resources_userinteractionresource.html">lib/resources/user<wbr>Interaction<wbr>Resource</a>
426+
<a href="modules/browser_utils.html">browser/utils</a>
427+
</li>
428+
<li class=" tsd-kind-module">
429+
<a href="modules/data_processing_compression.html">data-<wbr>processing/compression</a>
430+
</li>
431+
<li class=" tsd-kind-module">
432+
<a href="modules/data_processing_web_worker.html">data-<wbr>processing/web-<wbr>worker</a>
433+
</li>
434+
<li class=" tsd-kind-module">
435+
<a href="modules/index.html">index</a>
427436
</li>
428437
<li class=" tsd-kind-module">
429438
<a href="modules/react_components_withdatacontext.html">react/components/with<wbr>Data<wbr>Context</a>
@@ -434,6 +443,12 @@ <h2>Check out the <a href="./docs">docs</a> folder for a complete list of API re
434443
<li class=" tsd-kind-module">
435444
<a href="modules/react_contexts_datacontext.html">react/contexts/data<wbr>Context</a>
436445
</li>
446+
<li class=" tsd-kind-module">
447+
<a href="modules/resources_baseresource.html">resources/base<wbr>Resource</a>
448+
</li>
449+
<li class=" tsd-kind-module">
450+
<a href="modules/resources_userinteractionresource.html">resources/user<wbr>Interaction<wbr>Resource</a>
451+
</li>
437452
</ul>
438453
</nav>
439454
<nav class="tsd-navigation secondary menu-sticky">

0 commit comments

Comments
 (0)