update docs and announce new Link branding improvements#1770
update docs and announce new Link branding improvements#1770pmckinney-codat merged 5 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
||
| ### Hero image | ||
|
|
||
| This image is displayed as a background in Link, appearing behind the main content area. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is displayed').
| Hero image requirements: | ||
|
|
||
| - Use PNG, JPG, or JPEG file formats. | ||
| - Files should not exceed 10MB. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Contractions] Use 'shouldn't' instead of 'should not'.
| Hero image requirements: | ||
|
|
||
| - Use PNG, JPG, or JPEG file formats. | ||
| - Files should not exceed 10MB. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Google.Units] Put a nonbreaking space between the number and the unit in '10MB'.
|
|
||
| ### Secondary color | ||
|
|
||
| You can set your brand's secondary color, which is used for the navigation bar in Link. The navigation bar can be enabled in [Link settings](/auth-flow/customize/customize-link#navigation-bar). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is used').
|
|
||
| ### Secondary color | ||
|
|
||
| You can set your brand's secondary color, which is used for the navigation bar in Link. The navigation bar can be enabled in [Link settings](/auth-flow/customize/customize-link#navigation-bar). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be enabled').
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is displayed').
| | Error message | Error resolution | | ||
| | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | Company needs to have two valid data connections. | This error surfaces if a company doesn't have 2 valid data connections **OR** both data connections do not have the `linked` status. <br/> Ensure that the Codat company created for the merchant has 2 valid data connections. One commerce and one accounting connection are required. <br/> Ensure that the Codat company has both data connection statuses set to `linked` by using the public API connection resource **OR** via the-no code merchant link journey using the link URL generated by the Codat app portal. | | ||
| | Company needs to have two valid data connections. | This error surfaces if a company doesn't have 2 valid data connections **OR** both data connections do not have the `linked` status. <br/> Ensure that the Codat company created for the merchant has 2 valid data connections. One commerce and one accounting connection are required. <br/> Ensure that the Codat company has both data connection statuses set to `linked` by using the public API connection resource **OR** via the-no code merchant link journey using the link URL generated by the Codat app portal. | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Contractions] Use 'don't' instead of 'do not'.
| | Error message | Error resolution | | ||
| | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ||
| | Company needs to have two valid data connections. | This error surfaces if a company doesn't have 2 valid data connections **OR** both data connections do not have the `linked` status. <br/> Ensure that the Codat company created for the merchant has 2 valid data connections. One commerce and one accounting connection are required. <br/> Ensure that the Codat company has both data connection statuses set to `linked` by using the public API connection resource **OR** via the-no code merchant link journey using the link URL generated by the Codat app portal. | | ||
| | Company needs to have two valid data connections. | This error surfaces if a company doesn't have 2 valid data connections **OR** both data connections do not have the `linked` status. <br/> Ensure that the Codat company created for the merchant has 2 valid data connections. One commerce and one accounting connection are required. <br/> Ensure that the Codat company has both data connection statuses set to `linked` by using the public API connection resource **OR** via the-no code merchant link journey using the link URL generated by the Codat app portal. | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are required').
| | `Deauthorized` | The connection was linked but is no longer able to access data from the underlying provider's platform.<br/>You can access any data that was already read or written using this data connection. However, you can't perform any new read or write operations until the connection is re-linked.<br/>A data connection usually becomes Deauthorized if the company revoked your access or an expiry time was reached. | | ||
| | Status | Definition | | ||
| | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `Linked` | The connection is linked to a data source; you can use it to read and write a company's consented data to and from the underlying provider's platform. | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is linked').
| | Status | Definition | | ||
| | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `Linked` | The connection is linked to a data source; you can use it to read and write a company's consented data to and from the underlying provider's platform. | | ||
| | `PendingAuth` | The company hasn't authorized access to their financial platform (the data source). The SMB customer selected the platform in Link but did not complete the authorization flow. | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
| | Status | Definition | | ||
| | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `Linked` | The connection is linked to a data source; you can use it to read and write a company's consented data to and from the underlying provider's platform. | | ||
| | `PendingAuth` | The company hasn't authorized access to their financial platform (the data source). The SMB customer selected the platform in Link but did not complete the authorization flow. | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Contractions] Use 'didn't' instead of 'did not'.
| | :------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `Linked` | The connection is linked to a data source; you can use it to read and write a company's consented data to and from the underlying provider's platform. | | ||
| | `PendingAuth` | The company hasn't authorized access to their financial platform (the data source). The SMB customer selected the platform in Link but did not complete the authorization flow. | | ||
| | `Deauthorized` | The connection was linked but is no longer able to access data from the underlying provider's platform.<br/>You can access any data that was already read or written using this data connection. However, you can't perform any new read or write operations until the connection is re-linked.<br/>A data connection usually becomes Deauthorized if the company revoked your access or an expiry time was reached. | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('was reached').
| | `Deauthorized` | The connection was linked but is no longer able to access data from the underlying provider's platform.<br/>You can access any data that was already read or written using this data connection. However, you can't perform any new read or write operations until the connection is re-linked.<br/>A data connection usually becomes Deauthorized if the company revoked your access or an expiry time was reached. | | ||
| | `Unlinked` | The data connection was previously linked, but you have severed the connection and gave up your access. (see [Disconnect a data connection to revoke your access to a data source](/core-concepts/connections#disconnect-a-data-connection-to-revoke-your-access-to-a-data-source)).<br/>Similar to Deauthorized, you can still access any data that was already read or written using the data connection, but can't perform any new read or write operations unless the connection is re-linked. | | ||
| | No connections | The company has been created but does not have any connections to financial platforms established in any of the above statuses. | | ||
| | No connections | The company has been created but does not have any connections to financial platforms established in any of the above statuses. | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('been created').
| | `Deauthorized` | The connection was linked but is no longer able to access data from the underlying provider's platform.<br/>You can access any data that was already read or written using this data connection. However, you can't perform any new read or write operations until the connection is re-linked.<br/>A data connection usually becomes Deauthorized if the company revoked your access or an expiry time was reached. | | ||
| | `Unlinked` | The data connection was previously linked, but you have severed the connection and gave up your access. (see [Disconnect a data connection to revoke your access to a data source](/core-concepts/connections#disconnect-a-data-connection-to-revoke-your-access-to-a-data-source)).<br/>Similar to Deauthorized, you can still access any data that was already read or written using the data connection, but can't perform any new read or write operations unless the connection is re-linked. | | ||
| | No connections | The company has been created but does not have any connections to financial platforms established in any of the above statuses. | | ||
| | No connections | The company has been created but does not have any connections to financial platforms established in any of the above statuses. | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Contractions] Use 'doesn't' instead of 'does not'.
| | `Deauthorized` | The connection was linked but is no longer able to access data from the underlying provider's platform.<br/>You can access any data that was already read or written using this data connection. However, you can't perform any new read or write operations until the connection is re-linked.<br/>A data connection usually becomes Deauthorized if the company revoked your access or an expiry time was reached. | | ||
| | `Unlinked` | The data connection was previously linked, but you have severed the connection and gave up your access. (see [Disconnect a data connection to revoke your access to a data source](/core-concepts/connections#disconnect-a-data-connection-to-revoke-your-access-to-a-data-source)).<br/>Similar to Deauthorized, you can still access any data that was already read or written using the data connection, but can't perform any new read or write operations unless the connection is re-linked. | | ||
| | No connections | The company has been created but does not have any connections to financial platforms established in any of the above statuses. | | ||
| | No connections | The company has been created but does not have any connections to financial platforms established in any of the above statuses. | |
There was a problem hiding this comment.
[Google.WordList] Use 'preceding' instead of 'above'.
| --- | ||
|
|
||
| For most of our data types, we retrieve all available history. For financial statement data types, (`balanceSheet`, `profitAndLoss`, `cashFlowStatement`), we retrieve 24 months of history. | ||
| For most of our data types, we retrieve all available history. For financial statement data types, (`balanceSheet`, `profitAndLoss`, `cashFlowStatement`), we retrieve 24 months of history. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Parens] Use parentheses judiciously.
Updated the branding options for Link to enhance the authorization experience with new settings for logos, colors, and images.
Added information about autosaving branding settings to the overview section.
| Link is a white-labelled solution that can be matched to your company's branding. Go to **[Settings > Auth flow > Branding](https://app.codat.io/settings/branding)** in the [Codat Portal](https://app.codat.io) to tailor Link for a fully custom-branded experience. | ||
|
|
||
| The branding settings page autosaves when changes are made. You can adjust the following UI elements: | ||
| Link is a white-labelled solution that can be matched to your company's branding. Go to **[Settings > Auth flow > Branding](https://app.codat.io/settings/branding)** in the [Codat Portal](https://app.codat.io) to tailor Link for a fully custom-branded experience. The branding settings page autosaves when changes are made. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('be matched').
| Link is a white-labelled solution that can be matched to your company's branding. Go to **[Settings > Auth flow > Branding](https://app.codat.io/settings/branding)** in the [Codat Portal](https://app.codat.io) to tailor Link for a fully custom-branded experience. | ||
|
|
||
| The branding settings page autosaves when changes are made. You can adjust the following UI elements: | ||
| Link is a white-labelled solution that can be matched to your company's branding. Go to **[Settings > Auth flow > Branding](https://app.codat.io/settings/branding)** in the [Codat Portal](https://app.codat.io) to tailor Link for a fully custom-branded experience. The branding settings page autosaves when changes are made. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('are made').
| Allow your customers to restart the linking process for accounting software in case their first connection attempt fails. Enabling this setting will add a "Try again" button to the connection error page. | ||
|
|
||
| It's possible to restart the linking process for commerce and banking platforms by default and no additional settings are required. | ||
| Toggle whether a navigation bar is displayed at the top of the Link flow. The bar color uses the secondary brand color you set in [Branding settings](/auth-flow/customize/branding#secondary-color). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('is displayed').
|
Link check results for preview deployment (https://codat-docs-git-link-branding-updates-codat.vercel.app): |
Description
Providing details of recent Link branding improvements
Type of change
Please delete options that are not relevant.