From 697e0653345fdf8ca8cd181bfb83e21ce819e404 Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Wed, 31 Jan 2024 14:38:07 +0000 Subject: [PATCH 1/4] initial reorg --- docs/using-the-api/authentication.md | 1 + sidebars/use-the-api.js | 44 ++++++++++++++-------------- 2 files changed, 23 insertions(+), 22 deletions(-) diff --git a/docs/using-the-api/authentication.md b/docs/using-the-api/authentication.md index 7b9c72d4e..9ddfd39cb 100644 --- a/docs/using-the-api/authentication.md +++ b/docs/using-the-api/authentication.md @@ -1,6 +1,7 @@ --- title: "Authenticate" description: "Use your auth header or API key to authenticate with Codat's APIs" +aidebar_label: "API keys" --- API keys are tokens used to control access to the API. Codat expects the API key to be included in all requests to the server, Base64 encoded within an 'Authorization' header: diff --git a/sidebars/use-the-api.js b/sidebars/use-the-api.js index 1839c8117..939f34661 100644 --- a/sidebars/use-the-api.js +++ b/sidebars/use-the-api.js @@ -18,10 +18,27 @@ module.exports = [ "using-the-api/get-data", "using-the-api/queueing-data-syncs", "using-the-api/pull-history", + ], + }, + { + type: "category", + label: "Refine data", + collapsed: true, + items: [ "using-the-api/querying", "using-the-api/paging", "using-the-api/ordering-results", "using-the-api/modified-dates", + { + type: "category", + label: "Supplemental data", + collapsed: true, + items: [ + "using-the-api/supplemental-data/overview", + "using-the-api/supplemental-data/usecases", + ], + }, + "using-the-api/custom-data", ], }, { @@ -33,7 +50,6 @@ module.exports = [ "configure/portal/pull-and-push-history", ], }, - "using-the-api/testing", { type: "category", label: "Webhooks", @@ -48,33 +64,17 @@ module.exports = [ }, { type: "category", - label: "Supplemental data", - collapsed: true, - items: [ - "using-the-api/supplemental-data/overview", - "using-the-api/supplemental-data/usecases", - ], - }, - "using-the-api/custom-data", - { - type: "category", - label: "Best practices", + label: "Tips and guidance", collapsed: true, items: [ - "using-the-api/best-practices/implementing-a-mapping-page", - "using-the-api/best-practices/client-side-data-storage", - ], - }, - { - type: "category", - label: "Troubleshooting", - collapsed: true, - items: [ - "using-the-api/errors", "using-the-api/rate-limits", "using-the-api/optimizing-api-calls", + "using-the-api/testing", + "using-the-api/best-practices/implementing-a-mapping-page", + "using-the-api/best-practices/client-side-data-storage", ], }, + "using-the-api/errors", { type: "category", label: "Change management", From 29b9b2ea9bd15c26408fdd77f6d7a919a94aaf66 Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Wed, 31 Jan 2024 14:49:02 +0000 Subject: [PATCH 2/4] change titles --- docs/configure/portal/developers.md | 3 +-- docs/using-the-api/best-practices/client-side-data-storage.md | 4 ++-- .../best-practices/implementing-a-mapping-page.md | 2 +- docs/using-the-api/modified-dates.md | 4 +--- docs/using-the-api/optimizing-api-calls.md | 2 +- docs/using-the-api/ordering-results.md | 4 +--- 6 files changed, 7 insertions(+), 12 deletions(-) diff --git a/docs/configure/portal/developers.md b/docs/configure/portal/developers.md index f4a9a4519..404f0d9c7 100644 --- a/docs/configure/portal/developers.md +++ b/docs/configure/portal/developers.md @@ -1,8 +1,7 @@ --- title: "Enable deprecations" description: "Get ahead of upcoming deprecations in the Portal" -createdAt: "2022-09-05T15:58:36.027Z" -updatedAt: "2022-12-09T13:03:30.599Z" +sidebar_label: "Early deprecations" --- :::note Access to Codat Developers diff --git a/docs/using-the-api/best-practices/client-side-data-storage.md b/docs/using-the-api/best-practices/client-side-data-storage.md index 94f65fb06..6574867ed 100644 --- a/docs/using-the-api/best-practices/client-side-data-storage.md +++ b/docs/using-the-api/best-practices/client-side-data-storage.md @@ -1,7 +1,7 @@ --- -title: "Implementing client-side data storage" +title: "Implementing local data storage" description: "Tips and advice on storing, working with, and consuming Codat data" -sidebar_label: "Client-side data storage" +sidebar_label: "Local data storage" --- You can store JSON data retrieved from the Codat API in many different ways. We have described some of the options for you, but the right choice depends on your requirements and the tools and skillset you have available. diff --git a/docs/using-the-api/best-practices/implementing-a-mapping-page.md b/docs/using-the-api/best-practices/implementing-a-mapping-page.md index 4cfac2c73..0fb84f3a6 100644 --- a/docs/using-the-api/best-practices/implementing-a-mapping-page.md +++ b/docs/using-the-api/best-practices/implementing-a-mapping-page.md @@ -1,7 +1,7 @@ --- title: "Implementing an account mapping user interface" description: "Tips and advice on managing inconsistent accounts across your user base" -sidebar_label: "Account mapping user interface" +sidebar_label: "Mapping interface" --- Accounting platforms that your customers use normally offer them a default set of accounts (also known as chart of accounts), pre-defined to match accounting best practices. Your customers then have the ability to rename and renumber these accounts, or create new ones, to match their business needs. diff --git a/docs/using-the-api/modified-dates.md b/docs/using-the-api/modified-dates.md index cdddbcb23..78267afa7 100644 --- a/docs/using-the-api/modified-dates.md +++ b/docs/using-the-api/modified-dates.md @@ -1,8 +1,6 @@ --- -title: "Using modified dates" +title: "Use modified dates" description: "Understanding when data has been modified" -createdAt: "2022-11-07T19:53:44.472Z" -updatedAt: "2022-11-28T13:03:19.120Z" --- Codat surfaces two dates to indicate when data was last updated: diff --git a/docs/using-the-api/optimizing-api-calls.md b/docs/using-the-api/optimizing-api-calls.md index 0614f33f2..763c8de06 100644 --- a/docs/using-the-api/optimizing-api-calls.md +++ b/docs/using-the-api/optimizing-api-calls.md @@ -1,5 +1,5 @@ --- -title: "Optimizing API calls" +title: "Optimize API calls" description: "Learn how to use our APIs efficiently and ensure you are not reaching our rate limits" --- diff --git a/docs/using-the-api/ordering-results.md b/docs/using-the-api/ordering-results.md index 2c71d5447..9697d3be5 100644 --- a/docs/using-the-api/ordering-results.md +++ b/docs/using-the-api/ordering-results.md @@ -1,8 +1,6 @@ --- -title: "Ordering results" +title: "Order results" description: "Basics and examples of ordering in Codat's APIs" -createdAt: "2020-02-27T01:32:43.041Z" -updatedAt: "2022-11-07T20:00:50.251Z" --- In addition to [queries](/using-the-api/querying), you can limit response data using the `orderBy` parameter to specify the ordering of records in the response. From bfb5ecf025a784b38026fb6ae712afb4cccd3b63 Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Wed, 31 Jan 2024 14:49:25 +0000 Subject: [PATCH 3/4] typo fix --- docs/using-the-api/authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/using-the-api/authentication.md b/docs/using-the-api/authentication.md index 9ddfd39cb..7ccbfe301 100644 --- a/docs/using-the-api/authentication.md +++ b/docs/using-the-api/authentication.md @@ -1,7 +1,7 @@ --- title: "Authenticate" description: "Use your auth header or API key to authenticate with Codat's APIs" -aidebar_label: "API keys" +sidebar_label: "API keys" --- API keys are tokens used to control access to the API. Codat expects the API key to be included in all requests to the server, Base64 encoded within an 'Authorization' header: From 3cfd280082d87db22b0cf276622838643b712a80 Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Thu, 1 Feb 2024 10:41:19 +0000 Subject: [PATCH 4/4] revert Refine data --- sidebars/use-the-api.js | 7 ------- 1 file changed, 7 deletions(-) diff --git a/sidebars/use-the-api.js b/sidebars/use-the-api.js index 939f34661..fff8b9869 100644 --- a/sidebars/use-the-api.js +++ b/sidebars/use-the-api.js @@ -18,13 +18,6 @@ module.exports = [ "using-the-api/get-data", "using-the-api/queueing-data-syncs", "using-the-api/pull-history", - ], - }, - { - type: "category", - label: "Refine data", - collapsed: true, - items: [ "using-the-api/querying", "using-the-api/paging", "using-the-api/ordering-results",