Skip to content

Commit 05ec736

Browse files
committed
chore: add new guide documents
1 parent 14e9906 commit 05ec736

File tree

5 files changed

+35
-4
lines changed

5 files changed

+35
-4
lines changed

Authenticating.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
group: Guides
3+
category: Guides
4+
---
5+
# Authenticating
6+
7+
TODO: descript the authentification flow

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
## 2.0.4
1616

17-
## Updates
17+
### Updates
1818
- Added API documentation via Netlify([1087275](https://github.com/Iterable/react-native-sdk/commit/1087275))
1919
- Removed dependency on `react-native-vector-icons`, per issues
2020
[#513](https://github.com/Iterable/react-native-sdk/issues/513),

In-app Inbox.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
group: Guides
3+
category: Guides
4+
---
5+
# In-app Inbox
6+
7+
TODO: add instructions for the inbox

Quick Start.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
group: Guides
3+
category: Guides
4+
---
5+
# Quick Start
6+
7+
TODO: Add quick start instructions

typedoc.config.mjs

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,15 @@
22
/** @type { import('typedoc').TypeDocOptionMap & import('typedoc-umlclass').Config } */
33
const config = {
44
entryPoints: ['./src/index.tsx'],
5-
projectDocuments: ['README.md', 'most-used-modules.md', 'another-md.md'],
5+
projectDocuments: [
6+
'README.md',
7+
'Quick Start.md',
8+
'Authenticating.md',
9+
'In-app Inbox.md',
10+
'most-used-modules.md',
11+
'another-md.md',
12+
'CHANGELOG.md',
13+
],
614
out: './docs-gen',
715
tsconfig: './tsconfig.json',
816
excludeInternal: true,
@@ -46,7 +54,7 @@ const config = {
4654
document: false,
4755
},
4856
groupOrder: [
49-
'Documents',
57+
'Guides',
5058
'React Components',
5159
'Classes',
5260
'Enums',
@@ -57,7 +65,7 @@ const config = {
5765
'Constants',
5866
'*',
5967
],
60-
categoryOrder: ['Documents', 'React Components', '*'],
68+
categoryOrder: ['Guides', 'React Components', '*'],
6169
// jsDocCompatibility: {
6270
// inheritDocTag: true,
6371
// },
@@ -112,9 +120,11 @@ const config = {
112120
},
113121
searchCategoryBoosts: {
114122
'React Components': 1.5,
123+
'Guides': 1.5,
115124
},
116125
searchGroupBoosts: {
117126
'React Components': 1.5,
127+
'Guides': 1.5,
118128
},
119129
visibilityFilters: {
120130
'protected': false,

0 commit comments

Comments
 (0)