From 1442e42b0ad0a6ec96a20d929eecbf3233e3e606 Mon Sep 17 00:00:00 2001 From: Tyler <18113850+dshukertjr@users.noreply.github.com> Date: Tue, 14 Nov 2023 11:54:26 +0900 Subject: [PATCH] docs: update Kotlin docs to v1.0 (#18932) * update kotlin docs version number to v1.0 * renaming client to supabase for the installing kotlin guide --- .../Navigation/NavigationMenu/NavigationMenu.constants.ts | 2 +- .../Navigation/NavigationMenu/NavigationMenu.tsx | 2 +- apps/docs/docs/ref/kotlin/installing.mdx | 8 ++++---- apps/docs/internals/files/reference-lib.mjs | 2 +- apps/docs/pages/reference/kotlin/[...slug].tsx | 2 +- apps/docs/pages/reference/kotlin/crawlers/[...slug].tsx | 2 +- apps/docs/pages/reference/kotlin/v0/[...slug].tsx | 2 +- .../docs/pages/reference/kotlin/v0/crawlers/[...slug].tsx | 2 +- apps/docs/scripts/search/sources/index.ts | 2 +- spec/{supabase_kt_v0.yml => supabase_kt_v1.yml} | 2 +- 10 files changed, 13 insertions(+), 13 deletions(-) rename spec/{supabase_kt_v0.yml => supabase_kt_v1.yml} (99%) diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts index df69a6a301a..e582635c20c 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts @@ -208,7 +208,7 @@ export const REFERENCES: References = { kotlin: { name: 'Kotlin', library: 'supabase-kt', - versions: ['v0'], + versions: ['v1'], icon: '/docs/img/libraries/kotlin-icon.svg', }, cli: { diff --git a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.tsx b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.tsx index fe98fdbde9c..29c07ed55bd 100644 --- a/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.tsx +++ b/apps/docs/components/Navigation/NavigationMenu/NavigationMenu.tsx @@ -157,7 +157,7 @@ const menus: Menu[] = [ id: 'reference_kotlin_v0', path: '/reference/kotlin', commonSectionsFile: 'common-client-libs-sections.json', - specFile: 'supabase_kt_v0.yml', + specFile: 'supabase_kt_v1.yml', type: 'reference', }, { diff --git a/apps/docs/docs/ref/kotlin/installing.mdx b/apps/docs/docs/ref/kotlin/installing.mdx index a69a1ac0523..9022359b3f7 100644 --- a/apps/docs/docs/ref/kotlin/installing.mdx +++ b/apps/docs/docs/ref/kotlin/installing.mdx @@ -264,7 +264,7 @@ By default, [KotlinX Serialization](https://github.com/Kotlin/kotlinx.serializat ```kotlin - val client = createSupabaseClient(supabaseUrl, supabaseKey) { + val supabase = createSupabaseClient(supabaseUrl, supabaseKey) { //Already the default serializer } ``` @@ -312,7 +312,7 @@ By default, [KotlinX Serialization](https://github.com/Kotlin/kotlinx.serializat ```kotlin - val client = createSupabaseClient(supabaseUrl, supabaseKey) { + val supabase = createSupabaseClient(supabaseUrl, supabaseKey) { defaultSerializer = MoshiSerializer() } ``` @@ -361,7 +361,7 @@ By default, [KotlinX Serialization](https://github.com/Kotlin/kotlinx.serializat ```kotlin - val client = createSupabaseClient(supabaseUrl, supabaseKey) { + val supabase = createSupabaseClient(supabaseUrl, supabaseKey) { defaultSerializer = JacksonSerializer() } ``` @@ -392,7 +392,7 @@ By default, [KotlinX Serialization](https://github.com/Kotlin/kotlinx.serializat ``` ```kotlin - val client = createSupabaseClient(supabaseUrl, supabaseKey) { + val supabase = createSupabaseClient(supabaseUrl, supabaseKey) { defaultSerializer = CustomSerializer() } ``` diff --git a/apps/docs/internals/files/reference-lib.mjs b/apps/docs/internals/files/reference-lib.mjs index 673cfc49fdc..e374c9b2216 100644 --- a/apps/docs/internals/files/reference-lib.mjs +++ b/apps/docs/internals/files/reference-lib.mjs @@ -12,7 +12,7 @@ const clientLibFiles = [ { fileName: 'supabase_py_v2', label: 'python', version: 'v2', versionSlug: false }, { fileName: 'supabase_csharp_v0', label: 'csharp', version: 'v0', versionSlug: false }, { fileName: 'supabase_swift_v1', label: 'swift', version: 'v1', versionSlug: false }, - { fileName: 'supabase_kt_v0', label: 'kotlin', version: 'v0', versionSlug: false }, + { fileName: 'supabase_kt_v1', label: 'kotlin', version: 'v0', versionSlug: false }, ] export function generateReferencePages() { diff --git a/apps/docs/pages/reference/kotlin/[...slug].tsx b/apps/docs/pages/reference/kotlin/[...slug].tsx index dfce2170a7b..96e0008668f 100644 --- a/apps/docs/pages/reference/kotlin/[...slug].tsx +++ b/apps/docs/pages/reference/kotlin/[...slug].tsx @@ -1,5 +1,5 @@ import clientLibsCommonSections from '~/../../spec/common-client-libs-sections.json' -import spec from '~/../../spec/supabase_kt_v0.yml' assert { type: 'yml' } +import spec from '~/../../spec/supabase_kt_v1.yml' assert { type: 'yml' } import RefSectionHandler from '~/components/reference/RefSectionHandler' import { flattenSections } from '~/lib/helpers' import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths' diff --git a/apps/docs/pages/reference/kotlin/crawlers/[...slug].tsx b/apps/docs/pages/reference/kotlin/crawlers/[...slug].tsx index e6a69bf155f..412c43cc990 100644 --- a/apps/docs/pages/reference/kotlin/crawlers/[...slug].tsx +++ b/apps/docs/pages/reference/kotlin/crawlers/[...slug].tsx @@ -1,6 +1,6 @@ import clientLibsCommonSections from '~/../../spec/common-client-libs-sections.json' import typeSpec from '~/../../spec/enrichments/tsdoc_v2/combined.json' -import spec from '~/../../spec/supabase_kt_v0.yml' assert { type: 'yml' } +import spec from '~/../../spec/supabase_kt_v1.yml' assert { type: 'yml' } import RefSectionHandler from '~/components/reference/RefSectionHandler' import { flattenSections } from '~/lib/helpers' import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths' diff --git a/apps/docs/pages/reference/kotlin/v0/[...slug].tsx b/apps/docs/pages/reference/kotlin/v0/[...slug].tsx index 81ec54b2efe..5c39eba69bf 100644 --- a/apps/docs/pages/reference/kotlin/v0/[...slug].tsx +++ b/apps/docs/pages/reference/kotlin/v0/[...slug].tsx @@ -1,5 +1,5 @@ import clientLibsCommonSections from '~/../../spec/common-client-libs-sections.json' -import spec from '~/../../spec/supabase_kt_v0.yml' assert { type: 'yml' } +import spec from '~/../../spec/supabase_kt_v1.yml' assert { type: 'yml' } import RefSectionHandler from '~/components/reference/RefSectionHandler' import { flattenSections } from '~/lib/helpers' import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths' diff --git a/apps/docs/pages/reference/kotlin/v0/crawlers/[...slug].tsx b/apps/docs/pages/reference/kotlin/v0/crawlers/[...slug].tsx index 0bb3a187cc3..7aa638d5fe2 100644 --- a/apps/docs/pages/reference/kotlin/v0/crawlers/[...slug].tsx +++ b/apps/docs/pages/reference/kotlin/v0/crawlers/[...slug].tsx @@ -1,6 +1,6 @@ import clientLibsCommonSections from '~/../../spec/common-client-libs-sections.json' import typeSpec from '~/../../spec/enrichments/tsdoc_v2/combined.json' -import spec from '~/../../spec/supabase_kt_v0.yml' assert { type: 'yml' } +import spec from '~/../../spec/supabase_kt_v1.yml' assert { type: 'yml' } import RefSectionHandler from '~/components/reference/RefSectionHandler' import { flattenSections } from '~/lib/helpers' import handleRefGetStaticPaths from '~/lib/mdx/handleRefStaticPaths' diff --git a/apps/docs/scripts/search/sources/index.ts b/apps/docs/scripts/search/sources/index.ts index c8af243e5ca..349186f6365 100644 --- a/apps/docs/scripts/search/sources/index.ts +++ b/apps/docs/scripts/search/sources/index.ts @@ -72,7 +72,7 @@ export async function fetchSources() { 'kt-lib', '/reference/kotlin', { title: 'Kotlin Reference' }, - '../../spec/supabase_kt_v0.yml', + '../../spec/supabase_kt_v1.yml', '../../spec/common-client-libs-sections.json' ) diff --git a/spec/supabase_kt_v0.yml b/spec/supabase_kt_v1.yml similarity index 99% rename from spec/supabase_kt_v0.yml rename to spec/supabase_kt_v1.yml index 1e6d75d30b0..331ffeadce0 100644 --- a/spec/supabase_kt_v0.yml +++ b/spec/supabase_kt_v1.yml @@ -7,7 +7,7 @@ info: Supabase Kotlin. - specUrl: https://github.com/supabase/supabase/edit/master/spec/supabase_kt_v0.yml + specUrl: https://github.com/supabase/supabase/edit/master/spec/supabase_kt_v1.yml slugPrefix: '/' libraries: - name: 'Kotlin'