Merge pull request #66 from moovfinancial/doc-292-node-section-has-broken-links

FE-419 Node docs have broken links

Author: sethlivingston

README.md

@@ -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
 

docs/output/_index.md

@@ -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.
 
@@ -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.
 
@@ -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.
 

docs/output/accounts.md

@@ -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 |
@@ -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.

docs/output/cards.md

@@ -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 |

docs/output/transfers.md

@@ -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.

docs/templates/partials/member.hbs

@@ -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 .}}