Skip to content

Commit 8d973f0

Browse files
committed
docs: add GitHub Actions workflow for validating documentation
1 parent bef8d54 commit 8d973f0

File tree

2 files changed

+31
-15
lines changed

2 files changed

+31
-15
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Validate Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
merge_group:
11+
types:
12+
- checks_requested
13+
14+
jobs:
15+
validate-docs:
16+
runs-on: ubuntu-latest
17+
permissions:
18+
contents: read
19+
pull-requests: read
20+
21+
steps:
22+
- name: Checkout code
23+
uses: actions/checkout@v4
24+
with:
25+
fetch-depth: 0 # Fetch full history for proper git info
26+
27+
- name: Setup
28+
uses: ./.github/actions/setup
29+
30+
- name: Validate documentation
31+
run: yarn docs --validation --treatWarningsAsErrors --json /dev/null

src/core/classes/IterableConfig.ts

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,7 @@ 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-
*/
1912
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-
*/
2813
pushIntegrationName?: string;
2914

3015
/**

0 commit comments

Comments
 (0)