Skip to content

Commit 885deaa

Browse files
committed
docs: update documentation structure and remove outdated guides
1 parent 8d973f0 commit 885deaa

7 files changed

Lines changed: 17 additions & 78 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## 2.0.4
22

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

docs-static/Authenticating.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs-static/In-app Inbox.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs-static/Most Used Modules.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs-static/Quick Start.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

src/core/classes/IterableConfig.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,22 @@ import { IterableAction } from './IterableAction';
99
import type { IterableActionContext } from './IterableActionContext';
1010
import type { IterableAuthResponse } from './IterableAuthResponse';
1111

12+
/**
13+
* An IterableConfig object sets various properties of the SDK.
14+
*
15+
* An IterableConfig object is passed into the static initialize method on the
16+
* Iterable class when initializing the SDK.
17+
*
18+
*/
1219
export class IterableConfig {
20+
/**
21+
* The name of the Iterable push integration that will send push notifications to your app.
22+
*
23+
* Defaults to your app's application ID or bundle ID for iOS.
24+
*
25+
* Note: Don't specify this value unless you are using an older Iterable push integration that
26+
* has a custom name. To view your existing integrations, navigate to Settings \> Mobile Apps.
27+
*/
1328
pushIntegrationName?: string;
1429

1530
/**

typedoc.config.mjs

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,7 @@
11
/** @type {Partial<import('typedoc').TypeDocOptions>} */
22
const config = {
33
entryPoints: ['./src/index.tsx'],
4-
projectDocuments: [
5-
'README.md',
6-
'./docs-static/Quick Start.md',
7-
'./docs-static/Authenticating.md',
8-
'./docs-static/In-app Inbox.md',
9-
'./docs-static/Most Used Modules.md',
10-
'CHANGELOG.md',
11-
],
4+
projectDocuments: ['README.md', 'CHANGELOG.md'],
125
out: './docs',
136
tsconfig: './tsconfig.json',
147
excludeInternal: true,

0 commit comments

Comments
 (0)