From 639213539db93504ed38cb338e0d34d35aa07322 Mon Sep 17 00:00:00 2001 From: Evis Drenova <evis@usenucleus.cloud> Date: Fri, 24 May 2024 13:23:31 -0700 Subject: [PATCH 1/3] updated description meteadata in docs --- docs/docs/cli/accounts/list.mdx | 1 + docs/docs/cli/accounts/switch.mdx | 1 + docs/docs/cli/installing.mdx | 1 + docs/docs/cli/introduction.mdx | 1 + docs/docs/cli/jobs/list.mdx | 1 + docs/docs/cli/jobs/trigger.mdx | 1 + docs/docs/cli/login.mdx | 1 + docs/docs/cli/sync.mdx | 1 + docs/docs/cli/version.mdx | 1 + docs/docs/cli/whoami.mdx | 1 + docs/docs/connections/mysql.md | 3 +++ docs/docs/connections/postgres.md | 1 + docs/docs/connections/s3.md | 1 + docs/docs/deploy/authentication.md | 1 + docs/docs/deploy/docker-compose.md | 1 + docs/docs/deploy/environment-variables.md | 1 + docs/docs/deploy/introduction.mdx | 1 + docs/docs/deploy/kubernetes.md | 1 + docs/docs/guides/ai-synthetic-data-generation.md | 1 + docs/docs/guides/analytics.md | 1 + docs/docs/guides/creating-a-custom-code-transformer.md | 1 + docs/docs/guides/creating-a-data-gen-job.md | 1 + docs/docs/guides/creating-a-sync-job.md | 3 ++- docs/docs/guides/initializing-schemas.md | 3 ++- docs/docs/guides/neosync-local-dev.md | 1 + docs/docs/guides/terraform.md | 1 + docs/docs/guides/troubleshooting.md | 1 + docs/docs/guides/using-custom-llm-transformer.md | 1 + docs/docs/guides/using-neosync-in-your-CI.md | 1 + docs/docs/overview/core-concepts.mdx | 1 + docs/docs/overview/core-features.mdx | 1 + docs/docs/overview/introduction.mdx | 2 ++ docs/docs/overview/platform.mdx | 1 + docs/docs/overview/quickstart.mdx | 1 + docs/docs/overview/security-overview.mdx | 2 ++ docs/docs/overview/use-cases.mdx | 1 + docs/docs/table-constraints/circular-dependencies.mdx | 1 + docs/docs/table-constraints/foreign-keys.mdx | 1 + docs/docs/table-constraints/subsetting.mdx | 1 + docs/docs/transformers/introduction.mdx | 1 + docs/docs/transformers/system.md | 1 + docs/docs/transformers/user-defined.mdx | 1 + docs/docusaurus.config.ts | 9 ++++++++- 43 files changed, 56 insertions(+), 3 deletions(-) diff --git a/docs/docs/cli/accounts/list.mdx b/docs/docs/cli/accounts/list.mdx index 6483ae4ba3..9d7f945279 100644 --- a/docs/docs/cli/accounts/list.mdx +++ b/docs/docs/cli/accounts/list.mdx @@ -1,5 +1,6 @@ --- title: List +description: Learn how to list Neosync accounts with the neosync accounts list command. id: list hide_title: false slug: /cli/accounts/list diff --git a/docs/docs/cli/accounts/switch.mdx b/docs/docs/cli/accounts/switch.mdx index b857f8225c..bfb681e8f0 100644 --- a/docs/docs/cli/accounts/switch.mdx +++ b/docs/docs/cli/accounts/switch.mdx @@ -1,5 +1,6 @@ --- title: Switch +description: Learn how to switch accounts with the neosync accounts switch command. id: switch hide_title: false slug: /cli/accounts/switch diff --git a/docs/docs/cli/installing.mdx b/docs/docs/cli/installing.mdx index d06f4248da..fe96bb7e42 100644 --- a/docs/docs/cli/installing.mdx +++ b/docs/docs/cli/installing.mdx @@ -1,5 +1,6 @@ --- title: Installing +description: Learn how to trigger a Neosync job with the neosync jobs trigger command. id: installing hide_title: false slug: /cli/installing diff --git a/docs/docs/cli/introduction.mdx b/docs/docs/cli/introduction.mdx index be2441fa65..90b3036d9a 100644 --- a/docs/docs/cli/introduction.mdx +++ b/docs/docs/cli/introduction.mdx @@ -1,5 +1,6 @@ --- title: Introduction +description: This section details Neosync CLI and all of its available commands. id: intro hide_title: false slug: /cli/introduction diff --git a/docs/docs/cli/jobs/list.mdx b/docs/docs/cli/jobs/list.mdx index 36ada4d754..e99323c38a 100644 --- a/docs/docs/cli/jobs/list.mdx +++ b/docs/docs/cli/jobs/list.mdx @@ -1,5 +1,6 @@ --- title: List +description: Learn how to list Neosync jobs with the neosync jobs list command. id: list hide_title: false slug: /cli/jobs/list diff --git a/docs/docs/cli/jobs/trigger.mdx b/docs/docs/cli/jobs/trigger.mdx index 6e646071d7..d7ec4c8a07 100644 --- a/docs/docs/cli/jobs/trigger.mdx +++ b/docs/docs/cli/jobs/trigger.mdx @@ -1,5 +1,6 @@ --- title: Trigger +description: Learn how to trigger a Neosync job with the neosync jobs trigger command. id: trigger hide_title: false slug: /cli/jobs/trigger diff --git a/docs/docs/cli/login.mdx b/docs/docs/cli/login.mdx index 0bfc27f91e..6b01cca0e2 100644 --- a/docs/docs/cli/login.mdx +++ b/docs/docs/cli/login.mdx @@ -1,5 +1,6 @@ --- title: login +description: Learn how to login to neosync via the neosync login command. id: login hide_title: false slug: /cli/login diff --git a/docs/docs/cli/sync.mdx b/docs/docs/cli/sync.mdx index 2683de7229..fa459436d7 100644 --- a/docs/docs/cli/sync.mdx +++ b/docs/docs/cli/sync.mdx @@ -1,5 +1,6 @@ --- title: sync +description: Learn how to sync data to a local destination with the neosync sync CLI command. id: sync hide_title: false slug: /cli/sync diff --git a/docs/docs/cli/version.mdx b/docs/docs/cli/version.mdx index 9d1ddba0eb..e16ee9429e 100644 --- a/docs/docs/cli/version.mdx +++ b/docs/docs/cli/version.mdx @@ -1,5 +1,6 @@ --- title: Version +description: Learn how to view the Neosync CLI Version with the neosync version command and neosync --version flag. id: version hide_title: false slug: /cli/version diff --git a/docs/docs/cli/whoami.mdx b/docs/docs/cli/whoami.mdx index eeecd4975e..dfb07e5718 100644 --- a/docs/docs/cli/whoami.mdx +++ b/docs/docs/cli/whoami.mdx @@ -1,5 +1,6 @@ --- title: whoami +description: Learn how to display the currently logged in user with the neosync whoami CLI command. id: whoami hide_title: true slug: /cli/whoami diff --git a/docs/docs/connections/mysql.md b/docs/docs/connections/mysql.md index 7bb1d9a664..12993634f6 100644 --- a/docs/docs/connections/mysql.md +++ b/docs/docs/connections/mysql.md @@ -1,5 +1,6 @@ --- title: Mysql +description: Neosync supports most Mysql-compatible databases natively using the Mysql connection. id: mysql hide_title: false slug: /connections/mysql @@ -7,6 +8,8 @@ slug: /connections/mysql Neosync is an open-source, developer-first product that allows you to create anonymized, secure test data that you can sync across all of your environments for high quality local, stage and CI testing. +Neosync supports most Mysql-compatible databases natively using the Mysql connection. + ## MySQL Database Connection Configuration ![mysql](https://assets.nucleuscloud.com/neosync/docs/mysql.png) diff --git a/docs/docs/connections/postgres.md b/docs/docs/connections/postgres.md index 86de165b24..09a5be3dcc 100644 --- a/docs/docs/connections/postgres.md +++ b/docs/docs/connections/postgres.md @@ -1,5 +1,6 @@ --- title: PostgreSQL +description: Postgres is one of the most commonly used databases in the world and Neosync natively supports most postgres-compatible databases. id: postgres hide_title: false slug: /connections/postgres diff --git a/docs/docs/connections/s3.md b/docs/docs/connections/s3.md index 23a8fc677e..0f79201d99 100644 --- a/docs/docs/connections/s3.md +++ b/docs/docs/connections/s3.md @@ -1,5 +1,6 @@ --- title: S3 +description: Learn how to use Neosync to sync data from a database to AWS S3 id: s3 hide_title: false slug: /connections/s3 diff --git a/docs/docs/deploy/authentication.md b/docs/docs/deploy/authentication.md index c40a67eafe..5f9ad71629 100644 --- a/docs/docs/deploy/authentication.md +++ b/docs/docs/deploy/authentication.md @@ -1,5 +1,6 @@ --- title: Authentication +description: Learn how to configure and maintain authentication within Neosync open source id: auth hide_title: false slug: /deploy/authentication diff --git a/docs/docs/deploy/docker-compose.md b/docs/docs/deploy/docker-compose.md index 5d6882750a..7196dcfad0 100644 --- a/docs/docs/deploy/docker-compose.md +++ b/docs/docs/deploy/docker-compose.md @@ -1,5 +1,6 @@ --- title: Docker Compose +description: Learn how to deploy Neosync using Docker compose for a better local developer experience id: docker-compose hide_title: false slug: /deploy/docker-compose diff --git a/docs/docs/deploy/environment-variables.md b/docs/docs/deploy/environment-variables.md index 091d762158..6d2249bb45 100644 --- a/docs/docs/deploy/environment-variables.md +++ b/docs/docs/deploy/environment-variables.md @@ -1,5 +1,6 @@ --- title: Environment Variables +description: A listing of the environment variables that Neosync uses to work locally and in production id: env-vars hide_title: false slug: /deploy/environment-variables diff --git a/docs/docs/deploy/introduction.mdx b/docs/docs/deploy/introduction.mdx index 455c3cfb3b..0bf03c9470 100644 --- a/docs/docs/deploy/introduction.mdx +++ b/docs/docs/deploy/introduction.mdx @@ -1,5 +1,6 @@ --- title: Introduction +description: Learn how to Deploy Neosync locally and in Production with hands-on guides id: intro hide_title: false slug: /deploy/introduction diff --git a/docs/docs/deploy/kubernetes.md b/docs/docs/deploy/kubernetes.md index 99fec7ff1d..3cb56ce9c7 100644 --- a/docs/docs/deploy/kubernetes.md +++ b/docs/docs/deploy/kubernetes.md @@ -1,5 +1,6 @@ --- title: Kubernetes +description: The Kubernetes guide covers how to deploy Neosync specific resources. id: kubernetes hide_title: false slug: /deploy/kubernetes diff --git a/docs/docs/guides/ai-synthetic-data-generation.md b/docs/docs/guides/ai-synthetic-data-generation.md index aa0127b656..907264455d 100644 --- a/docs/docs/guides/ai-synthetic-data-generation.md +++ b/docs/docs/guides/ai-synthetic-data-generation.md @@ -1,5 +1,6 @@ --- title: AI Synthetic Data Generation +description: Learn how to use AI to generate realistic synthetic data using any LLM provider such as OpenAI, Anthropic, Gemini and more id: ai-synthetic-data-generation hide_title: false slug: /guides/ai-synthetic-data-generation diff --git a/docs/docs/guides/analytics.md b/docs/docs/guides/analytics.md index 45da4e6631..e871401fb4 100644 --- a/docs/docs/guides/analytics.md +++ b/docs/docs/guides/analytics.md @@ -1,5 +1,6 @@ --- title: Configuring Analytics +description: Learn how to configure analytics within Neosync open source and turn it off or not based on your preferences id: analytics hide_title: false slug: /guides/analytics diff --git a/docs/docs/guides/creating-a-custom-code-transformer.md b/docs/docs/guides/creating-a-custom-code-transformer.md index 95c80c3ce2..61154a4420 100644 --- a/docs/docs/guides/creating-a-custom-code-transformer.md +++ b/docs/docs/guides/creating-a-custom-code-transformer.md @@ -1,5 +1,6 @@ --- title: Creating a Custom Code Transformer +description: Learn how to create a custom code transformer that you can use to implement your own anonymization and synthetic data logic id: custom-code-transformers hide_title: false slug: /guides/custom-code-transformers diff --git a/docs/docs/guides/creating-a-data-gen-job.md b/docs/docs/guides/creating-a-data-gen-job.md index 3adb0107fc..185943d639 100644 --- a/docs/docs/guides/creating-a-data-gen-job.md +++ b/docs/docs/guides/creating-a-data-gen-job.md @@ -1,5 +1,6 @@ --- title: Creating a Data Generation Job +description: Learn how to create a data generation job in Neosync which allows you to generate synthetic data from scratch id: creating-a-data-gen-job hide_title: false slug: /guides/creating-a-data-gen-job diff --git a/docs/docs/guides/creating-a-sync-job.md b/docs/docs/guides/creating-a-sync-job.md index a033c43907..60b5c49b4d 100644 --- a/docs/docs/guides/creating-a-sync-job.md +++ b/docs/docs/guides/creating-a-sync-job.md @@ -1,5 +1,6 @@ --- title: Creating a Sync Job +description: Learn how to create a data sync job to anonymize and transform data from a source database to one or multiple destination databases id: creating-a-sync-job hide_title: false slug: /guides/creating-a-sync-job @@ -11,7 +12,7 @@ In this guide we will walk through how to create a [sync job](/core-concepts#job 1. Syncing and anonymizing prod data to lower level environments 2. Syncing data between two lower level environments with no transformations -3. Syncing and anonymizing data to be used for analytical and machine learning usecases such as training a model +3. Syncing and anonymizing data to be used for analytical and machine learning use cases such as training a model ## Creating a Sync Job diff --git a/docs/docs/guides/initializing-schemas.md b/docs/docs/guides/initializing-schemas.md index f042c20911..237ab56895 100644 --- a/docs/docs/guides/initializing-schemas.md +++ b/docs/docs/guides/initializing-schemas.md @@ -1,5 +1,6 @@ --- title: Initializing your Schema +description: Learn how to use Neosync to initialize your schema in your destination database to make it easier to hydrate your database with data id: initializing-your-schema hide_title: false slug: /guides/initializing-schemas @@ -18,7 +19,7 @@ This can potentially have some issues if you have a lot of migrations or if your If your migrations are any of the following you may run into issues: - Not Idempotent, meaning that running the migration multiple times (or against a completely blank/fresh database) will cause issues -- Have hard coded database names (if you are choosing to run neosync against a separate logical database in your single instance) +- Have hard coded database names (if you are choosing to run Neosync against a separate logical database in your single instance) - Edit database users, global configurations or other settings that are not related to the schema/data Some of the above issues can be resolved by choosing to run your migrations against a completely fresh database. diff --git a/docs/docs/guides/neosync-local-dev.md b/docs/docs/guides/neosync-local-dev.md index 9e7c00f4ce..1e4c1a3e69 100644 --- a/docs/docs/guides/neosync-local-dev.md +++ b/docs/docs/guides/neosync-local-dev.md @@ -1,5 +1,6 @@ --- title: Developing Neosync Locally +description: Learn how to develop with Neosync Open Source locally in order to get up to speed with how Neosync works id: neosync-local-dev hide_title: false slug: /guides/neosync-local-dev diff --git a/docs/docs/guides/terraform.md b/docs/docs/guides/terraform.md index 9507867d50..d1c055a723 100644 --- a/docs/docs/guides/terraform.md +++ b/docs/docs/guides/terraform.md @@ -1,5 +1,6 @@ --- title: Configuring Neosync with Terraform +description: Learn how to use Neosync's Terraform provider within your GitOps flow to manage your Terraform infrastructure id: terraform hide_title: false slug: /guides/terraform diff --git a/docs/docs/guides/troubleshooting.md b/docs/docs/guides/troubleshooting.md index 58ecc308fe..04bda32492 100644 --- a/docs/docs/guides/troubleshooting.md +++ b/docs/docs/guides/troubleshooting.md @@ -1,5 +1,6 @@ --- title: Troubleshooting Neosync Jobs +description: Learn how to troubleshoot common errors in Neosync with this guide id: troubleshooting hide_title: false slug: /guides/troubleshooting diff --git a/docs/docs/guides/using-custom-llm-transformer.md b/docs/docs/guides/using-custom-llm-transformer.md index 5fd523ceb0..b414a3794a 100644 --- a/docs/docs/guides/using-custom-llm-transformer.md +++ b/docs/docs/guides/using-custom-llm-transformer.md @@ -1,5 +1,6 @@ --- title: Using a Custom LLM Transformer +description: Learn how to use a custom LLM transformer in Neosync in order to call an LLM on every row to generate data or anonymize existing data id: using-custom-llm-transformer hide_title: false slug: /guides/using-custom-llm-transformer diff --git a/docs/docs/guides/using-neosync-in-your-CI.md b/docs/docs/guides/using-neosync-in-your-CI.md index 92e1137bc5..4e8454644d 100644 --- a/docs/docs/guides/using-neosync-in-your-CI.md +++ b/docs/docs/guides/using-neosync-in-your-CI.md @@ -1,5 +1,6 @@ --- title: Using Neosync in CI +description: Learn how to use Neosync in your CI pipelines in order to hydrate your CI databases with anonymized production data id: using-neosync-in-ci hide_title: false slug: /guides/using-neosync-in-ci diff --git a/docs/docs/overview/core-concepts.mdx b/docs/docs/overview/core-concepts.mdx index 1ec0e474c4..c7f6984a71 100644 --- a/docs/docs/overview/core-concepts.mdx +++ b/docs/docs/overview/core-concepts.mdx @@ -1,5 +1,6 @@ --- title: Core Concepts +description: The best way to learn about Neosync is to understand the core concepts of the platform. id: core-concepts hide_title: false slug: /core-concepts diff --git a/docs/docs/overview/core-features.mdx b/docs/docs/overview/core-features.mdx index 261e5b00f5..d2a4f8741d 100644 --- a/docs/docs/overview/core-features.mdx +++ b/docs/docs/overview/core-features.mdx @@ -1,5 +1,6 @@ --- title: Core Features +description: Learn about the core anonymization, synthetic data, orchestration and subsetting features of the Neosync platform id: core-features hide_title: false slug: /core-features diff --git a/docs/docs/overview/introduction.mdx b/docs/docs/overview/introduction.mdx index 93c77dae1c..fee9a853d3 100644 --- a/docs/docs/overview/introduction.mdx +++ b/docs/docs/overview/introduction.mdx @@ -1,5 +1,7 @@ --- title: Introduction +description: Neosync is an open-source, developer-first way to anonymize PII, generate synthetic data and sync environments for better +testing, debugging and developer experience. id: intro hide_title: false slug: / diff --git a/docs/docs/overview/platform.mdx b/docs/docs/overview/platform.mdx index a82ae26e4f..a5465c7dd4 100644 --- a/docs/docs/overview/platform.mdx +++ b/docs/docs/overview/platform.mdx @@ -1,5 +1,6 @@ --- title: Platform +description: Learn about component in the Neosync system and where it fits in the overall architecture id: platform hide_title: false slug: /platform diff --git a/docs/docs/overview/quickstart.mdx b/docs/docs/overview/quickstart.mdx index 231485af00..7a71ff1ebe 100644 --- a/docs/docs/overview/quickstart.mdx +++ b/docs/docs/overview/quickstart.mdx @@ -1,5 +1,6 @@ --- title: Quick start +description: Learn how to seed a PostgreSQL database with synthetic data for better data security and privacy id: quickstart hide_title: false slug: /quickstart diff --git a/docs/docs/overview/security-overview.mdx b/docs/docs/overview/security-overview.mdx index bbe2b3fc90..21c02d47d1 100644 --- a/docs/docs/overview/security-overview.mdx +++ b/docs/docs/overview/security-overview.mdx @@ -1,5 +1,6 @@ --- title: Neosync Cloud Security Overview +description: Learn how Neosync Cloud is secured and the security principles of the Neosync Platform id: cloud-security-overview hide_title: false slug: /cloud-security-overview @@ -8,6 +9,7 @@ slug: /cloud-security-overview At Neosync, we take as many security precautions as we can to ensure that any information saved on our server is safe. This section will document a few different things that we feel are worth mentioning from a security perspective. + This page is mostly relevant to Neosync Cloud. ## Code diff --git a/docs/docs/overview/use-cases.mdx b/docs/docs/overview/use-cases.mdx index d1b9174934..a589f04e5f 100644 --- a/docs/docs/overview/use-cases.mdx +++ b/docs/docs/overview/use-cases.mdx @@ -1,5 +1,6 @@ --- title: Use cases +description: Learn about the main use-cases of Neosync from anonymizing production data to subsetting data id: usecases hide_title: false slug: /usecases diff --git a/docs/docs/table-constraints/circular-dependencies.mdx b/docs/docs/table-constraints/circular-dependencies.mdx index bc27bb4865..3ce1300c95 100644 --- a/docs/docs/table-constraints/circular-dependencies.mdx +++ b/docs/docs/table-constraints/circular-dependencies.mdx @@ -1,5 +1,6 @@ --- title: Circular Dependencies +description: Learn how Neosync handles circular dependencies when anonymizing and subsetting data id: circular-dependencies hide_title: false slug: /table-constraints/circular-dependencies diff --git a/docs/docs/table-constraints/foreign-keys.mdx b/docs/docs/table-constraints/foreign-keys.mdx index 9743bc3e91..bb256087b1 100644 --- a/docs/docs/table-constraints/foreign-keys.mdx +++ b/docs/docs/table-constraints/foreign-keys.mdx @@ -1,5 +1,6 @@ --- title: Foreign Keys +description: Learn how Neosync handles foreign keys when anonymizing and subsetting data id: foreign-keys hide_title: false slug: /table-constraints/foreign-keys diff --git a/docs/docs/table-constraints/subsetting.mdx b/docs/docs/table-constraints/subsetting.mdx index 3d1193dcb2..c9e0201010 100644 --- a/docs/docs/table-constraints/subsetting.mdx +++ b/docs/docs/table-constraints/subsetting.mdx @@ -1,5 +1,6 @@ --- title: Subsetting +description: Learn how Neosync subsets data for a better local development experience id: subsetting hide_title: false slug: /table-constraints/subsetting diff --git a/docs/docs/transformers/introduction.mdx b/docs/docs/transformers/introduction.mdx index 1b011227bb..a296ccc37e 100644 --- a/docs/docs/transformers/introduction.mdx +++ b/docs/docs/transformers/introduction.mdx @@ -1,5 +1,6 @@ --- title: Introduction +description: Learn about Neosync transformers and how you can use them to anonymize data and generate synthetic data id: introduction hide_title: false slug: /transformers/introduction diff --git a/docs/docs/transformers/system.md b/docs/docs/transformers/system.md index fb1c498068..84ee57c018 100644 --- a/docs/docs/transformers/system.md +++ b/docs/docs/transformers/system.md @@ -1,5 +1,6 @@ --- title: System Transformers +description: Learn about Neosync's system transformers that come out of the box and help anonymize data and generate synthetic data id: system hide_title: false slug: /transformers/system diff --git a/docs/docs/transformers/user-defined.mdx b/docs/docs/transformers/user-defined.mdx index 4a322ebd80..227be108b0 100644 --- a/docs/docs/transformers/user-defined.mdx +++ b/docs/docs/transformers/user-defined.mdx @@ -1,5 +1,6 @@ --- title: User Defined Transformers +description: Learn about Neosync's user defined transformers and how you can create one to implement custom anonymization logic id: user-defined hide_title: false slug: /transformers/user-defined diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts index a2765141dc..a36e9c7b3c 100644 --- a/docs/docusaurus.config.ts +++ b/docs/docusaurus.config.ts @@ -6,7 +6,7 @@ import { themes } from 'prism-react-renderer'; const config: Config = { title: 'Neosync', - tagline: 'Open source Test Data Management', + tagline: 'Open source Data Anonymization and Synthetic Data', favicon: 'img/logo_light_mode.png', headTags: [ { @@ -109,6 +109,13 @@ const config: Config = { ], themeConfig: { + metadata: [ + { + name: 'keywords', + content: + 'open source, anonymization, data anonymization, synthetic data, data privacy, data security', + }, + ], image: 'img/docsOG.png', colorMode: { defaultMode: 'light', From 2d6533f64a0165695566164639f801645b63dc5a Mon Sep 17 00:00:00 2001 From: Evis Drenova <evis@usenucleus.cloud> Date: Fri, 24 May 2024 13:31:59 -0700 Subject: [PATCH 2/3] update descriptions in docs --- docs/docs/overview/introduction.mdx | 3 +-- docs/protos/go.md | 1 + docs/protos/home.md | 1 + docs/protos/typescript.md | 1 + 4 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/docs/overview/introduction.mdx b/docs/docs/overview/introduction.mdx index fee9a853d3..00baf76d68 100644 --- a/docs/docs/overview/introduction.mdx +++ b/docs/docs/overview/introduction.mdx @@ -1,7 +1,6 @@ --- title: Introduction -description: Neosync is an open-source, developer-first way to anonymize PII, generate synthetic data and sync environments for better -testing, debugging and developer experience. +description: Neosync is an open-source, developer-first way to anonymize PII, generate synthetic data and sync environments for better testing, debugging and developer experience id: intro hide_title: false slug: / diff --git a/docs/protos/go.md b/docs/protos/go.md index 38334e782b..321cb35d33 100644 --- a/docs/protos/go.md +++ b/docs/protos/go.md @@ -1,5 +1,6 @@ --- title: Neosync for Go +description: Learn about Neosync's Go SDK and how you can use it to anonymize data and generate synthetic data id: go hide_title: false slug: /go diff --git a/docs/protos/home.md b/docs/protos/home.md index 574c6e5337..5e1a608317 100644 --- a/docs/protos/home.md +++ b/docs/protos/home.md @@ -1,5 +1,6 @@ --- title: APIs and SDKs +description: Learn about Neosync's APIs and SDKs in order to anonymize data and generate synthetic data hide_title: false id: home slug: / diff --git a/docs/protos/typescript.md b/docs/protos/typescript.md index e0b1cdbc34..e358459c69 100644 --- a/docs/protos/typescript.md +++ b/docs/protos/typescript.md @@ -1,5 +1,6 @@ --- title: Neosync for TypeScript +description: Learn about Neosync's Typescript SDK and how you can use it to anonymize data and generate synthetic data id: typescript hide_title: false slug: /typescript From 334d0b0c7ff5969a2809b22cf115ec53d2329eff Mon Sep 17 00:00:00 2001 From: Evis Drenova <evis@usenucleus.cloud> Date: Fri, 24 May 2024 13:38:14 -0700 Subject: [PATCH 3/3] update spellcheck --- docs/cspell.json | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/cspell.json b/docs/cspell.json index dfc37bd692..c64db929b0 100644 --- a/docs/cspell.json +++ b/docs/cspell.json @@ -77,7 +77,20 @@ "Quickstart", "llms", "cust", - "VARCHAR" + "VARCHAR", + "llmprompt", + "datasubsetting", + "orches", + "DPDP", + "circref", + "circdeps", + "foreignkey", + "foreignkeyhover", + "fkhover", + "foreignkey", + "fkref", + "circref", + "subsetimg" ], "flagWords": ["hte"], "files": ["blog/**/*.md*", "docs/**/*.md*"],