Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FE-419 Node docs have broken links #66

Merged
merged 2 commits into from
Sep 6, 2022
Merged

FE-419 Node docs have broken links #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
249fef8
Use dashed-case (aka param-case) for links
sethlivingston Sep 2, 2022
7e0195e
More README info
sethlivingston Sep 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,19 @@ The following JSDoc tags should be included on any functions, methods, types, an

@enum - To document Enums

@private - To not include the in any public documentation for customers.
@private - To not include the in any public documentation for customers.

## Documentation generation

To generate the documentation, run

```bash
npm run docs
```

The generation logic is in `scripts/generateDocs.cjs`. We parse the raw data produced by JSDoc and then run it through a set of handlebars templates in `docs/templates`. The final output is in `docs/output`.

Handlebars "helpers" do a lot of the custom documentation generation we require for our documentation website. See the calls to `handlebars.registerHelper()` in `scripts/generateDocs.cjs` for more information.

## Troubleshooting and support

Expand Down
6 changes: 3 additions & 3 deletions docs/output/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ try {
moov.enrichedAddresses
```

Read more on [enrichedAddresses](enriched-Addresses) in the Moov Node SDK.
Read more on [enrichedAddresses](enriched-addresses) in the Moov Node SDK.

Gets the Enriched Address API.

Expand All @@ -213,7 +213,7 @@ try {
moov.enrichedProfiles
```

Read more on [enrichedProfiles](enriched-Profiles) in the Moov Node SDK.
Read more on [enrichedProfiles](enriched-profiles) in the Moov Node SDK.

Gets the Enriched Profile API.

Expand All @@ -237,7 +237,7 @@ try {
moov.paymentMethods
```

Read more on [paymentMethods](payment-Methods) in the Moov Node SDK.
Read more on [paymentMethods](payment-methods) in the Moov Node SDK.

Gets the Payment Methods API.

Expand Down
13 changes: 13 additions & 0 deletions docs/output/accounts.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ Describes a Moov account associated with an individual or a business.
| profile | [Profile](#profile) | Details for individual or business |
| metadata | `object` | Arbitrary key-value pairs |
| foreignID | `string` | Optional identification or alias |
| verification | [AccountVerification](#accountverification) | Describes identity verification status and relevant identity verification documents |
| customerSupport | [CustomerSupport](#customersupport), `null` | Displayed on credit card transactions (business only) |
| settings | [AccountSettings](#accountsettings), `null` | Account settings |
| createdOn | `string` | Date account was created |
Expand Down Expand Up @@ -534,6 +535,18 @@ Describes the responsibilities associated with a business representative.



### AccountVerification

Describes the verification state of an account

**Properties**

| Property | Type | Description |
| ---- | ---- | ----------- |
| verificationStatus | `unverified`, `pending`, `resubmit`, `review`, `verified`, `failed`| The status of an identity verification for a profile |



### CustomerSupport

Describes customer support contact information for a business account.
Expand Down
13 changes: 0 additions & 13 deletions docs/output/cards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,19 +192,6 @@ Describes a Card account.



**Properties**

| Property | Type | Description |
| ---- | ---- | ----------- |
| dynamicDescriptor | `string`| An optional override of the default card statement descriptor for a single transfer. |
| merchantInitiatedType | `recurring`, `unscheduled`, `null`| Enum: [recurring unscheduled] Describes how the card transaction was initiated |



### CardDetails



**Properties**

| Property | Type | Description |
Expand Down
13 changes: 13 additions & 0 deletions docs/output/transfers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,19 @@ try {


## Types
### CardDetails



**Properties**

| Property | Type | Description |
| ---- | ---- | ----------- |
| dynamicDescriptor | `string`| An optional override of the default card statement descriptor for a single transfer. |
| transactionSource | `first-recurring`, `recurring`, `unscheduled`, `null`| Enum: [first-recurring recurring unscheduled] Describes how the card transaction was initiated |



### PaymentMethodAccount

High-level account information associated with a payment method.
Expand Down
2 changes: 1 addition & 1 deletion docs/templates/partials/member.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{{lowercase memberof}}.{{name}}
```

Read more on [{{name}}]({{name}}) in the Moov Node SDK.
Read more on [{{name}}]({{paramCase name}}) in the Moov Node SDK.

{{summaryOrDescription .}}

Expand Down
Loading