new docs sync with git

Author: sonalgoyal

docs/README.md

@@ -1,30 +1,25 @@
 ---
-description: Hope you find us useful :-)
+description: >-
+  ML-powered entity resolution and record matching - built for your warehouse,
+  at any scale.
 ---
 
-# Welcome To Zingg
+# What is Zingg
 
-This is the latest documentation for Zingg. Release wise documentation can be accessed through:
+Most teams don't have a duplication problem; they have an entity resolution problem. The same entity lives in five systems under three different names. Every downstream decision built on that data becomes unreliable: analytics produce conflicting numbers, compliance checks miss connections, and operational teams work from different versions of the same record. When AI agents are in the loop, the problem compounds; an agent doesn't know a record is a duplicate, so it acts on each one independently, multiplying errors at the speed of automation.
 
-* [v0.6.0](https://docs.zingg.ai/0.6.0/)
-* [v0.5.0](https://app.gitbook.com/o/kn0G4kXLdlfPagjso48S/s/LzEhax5IUbfFVRkRns9Q/)
-* [v0.4.0](https://app.gitbook.com/o/kn0G4kXLdlfPagjso48S/s/a7sgpR3odgfck5L8KMcN/)
-* [v0.3.4](https://app.gitbook.com/o/kn0G4kXLdlfPagjso48S/s/ngqsuC2LVWwrOiyPZbU2/)
-* [v0.3.3](https://app.gitbook.com/o/kn0G4kXLdlfPagjso48S/s/1ZRr4ik7PJ2qmCP10In9/)
+Solving this at scale is harder than it looks. The number of comparisons grows quadratically with record count, and rule-based approaches break down on real-world data variation.
 
-## Why?
+Zingg solves this with ML-powered entity resolution that runs directly on your infrastructure on Spark or Snowflake, so your data never leaves your premises. You label a small set of example pairs to teach Zingg what a match looks like for your data. Zingg learns from those labels, adapts as it sees more variation, and scales that judgment across millions of records, giving your pipelines and agents a resolved, trustworthy view of every entity to act on.
 
-Data silos hurt all business functions - customer analytics, supplier consolidation, risk and compliance, and sales and marketing.
 
-![Data Silos](.gitbook/assets/dataSilos.png)
 
-Zingg is a quick and scalable way to build a single source of truth for core business entities. With Zingg, the analytics engineer and the data scientist can quickly integrate data silos and build unified views at scale!
+<figure><img src=".gitbook/assets/image (36).png" alt=""><figcaption></figcaption></figure>
 
-![# Zingg - Data Mastering At Scale with ML](.gitbook/assets/dataMastering.png)
+Whether you're resolving customers, patients, suppliers, citizens, or product issues—Zingg works on any entity type.
 
-<figure><img src="https://static.scarf.sh/a.png?x-pxid=b96858f2-6fe2-4fdf-a68b-946527ca3daf" alt=""><figcaption></figcaption></figure>
+### What do you want to do today?
 
-## Ask For Help
-
-If you want to understand if Zingg is a fit for your use case or have other questions or suggestions, join our [Slack.](https://join.slack.com/t/zinggai/shared_invite/zt-w7zlcnol-vEuqU9m~Q56kLLUVxRgpOA)
+<table data-view="cards"><thead><tr><th></th><th data-type="content-ref"></th><th><select></select></th><th></th></tr></thead><tbody><tr><td><mark style="color:violet;background-color:violet;"><strong>What is entity resolution</strong></mark></td><td><a href="zingg-concepts/entity-resolution/">entity-resolution</a></td><td></td><td>Understand the problem Zingg solves, why fragmented entity data breaks downstream systems, and why rule-based approaches fail at scale.</td></tr><tr><td><mark style="color:violet;background-color:violet;"><strong>Run Zingg for the first time</strong></mark></td><td><a href="https://app.gitbook.com/s/4FvYw4VaCJcugJzWCiLX/running-zingg">Running Zingg</a></td><td></td><td>Get Zingg running on your platform and see your first match result in under 30 minutes.</td></tr><tr><td><mark style="color:violet;background-color:violet;"><strong>Connect your data</strong></mark></td><td><a href="https://app.gitbook.com/s/4FvYw4VaCJcugJzWCiLX/connect-your-data">Connect Your Data</a></td><td></td><td>Configure Zingg pipes for your data source - cloud warehouses, cloud storage, databases, and file formats.</td></tr><tr><td><mark style="color:violet;background-color:violet;"><strong>Build and train a model</strong></mark></td><td><a href="/broken/pages/kmbn0lMNm0Gkg9cfafx5">Broken link</a></td><td></td><td>Configure your data, label training pairs, and build a model for your dataset.</td></tr><tr><td><mark style="color:violet;background-color:violet;"><strong>Interpret and tune results</strong></mark></td><td><a href="https://app.gitbook.com/s/4FvYw4VaCJcugJzWCiLX/tuning">Tuning</a></td><td></td><td>Understand your match output, set thresholds, and improve accuracy.</td></tr><tr><td><mark style="color:violet;background-color:violet;"><strong>References</strong></mark></td><td><a href="https://app.gitbook.com/s/4FvYw4VaCJcugJzWCiLX/reference">Reference</a></td><td></td><td>Configuration schema, CLI commands, runtime properties, and FAQ.</td></tr></tbody></table>
 
+{% embed url="https://www.zingg.ai/company/contact/contact" %}

docs/SUMMARY.md

@@ -1,101 +1,132 @@
 # Table of contents
 
-* [Welcome To Zingg](README.md)
-* [Step-By-Step Guide](stepByStep.md)
-  * [Installation](setup/installation.md)
-    * [Docker](stepbystep/installation/docker/README.md)
-      * [Sharing Custom Data And Config Files](stepbystep/installation/docker/sharing-custom-data-and-config-files.md)
-      * [Shared Locations](stepbystep/installation/docker/shared-locations.md)
-      * [File Read/Write Permissions](stepbystep/installation/docker/file-read-write-permissions.md)
-      * [Copying Files To And From The Container](stepbystep/installation/docker/copying-files-to-and-from-the-container.md)
-    * [Installing From Release](stepbystep/installation/installing-from-release/README.md)
-      * [Single Machine Setup](stepbystep/installation/installing-from-release/single-machine-setup.md)
-      * [Spark Cluster Checklist](stepbystep/installation/installing-from-release/spark-cluster-checklist.md)
-      * [Installing Zingg](stepbystep/installation/installing-from-release/installing-zingg.md)
-      * [Verifying The Installation](stepbystep/installation/installing-from-release/verification.md)
-    * [Enterprise Installation for Snowflake](stepbystep/installation/installing-zingg-enterprise-snowflake/README.md)
-      * [Setting up Zingg](stepbystep/installation/installing-zingg-enterprise-snowflake/setting-up-zingg-enterprise-for-snowflake.md)
-      * [Snowflake Properties](stepbystep/installation/installing-zingg-enterprise-snowflake/snowflake-properties.md)
-      * [Match Configuration](stepbystep/installation/installing-zingg-enterprise-snowflake/match-configuration.md)
-      * [Running Asynchronously](stepbystep/installation/installing-zingg-enterprise-snowflake/running-asynchronously.md)
-      * [Verifying The Installation](stepbystep/installation/installing-zingg-enterprise-snowflake/verifying-the-installation.md)
-    * [Compiling From Source](stepbystep/installation/compiling-from-source.md)
-  * [Hardware Sizing](setup/hardwareSizing.md)
-  * [Zingg Runtime Properties](stepbystep/zingg-runtime-properties.md)
-  * [Zingg Command Line](stepbystep/zingg-command-line.md)
-  * [Configuration](stepbystep/configuration/README.md)
-    * [Configuring Through Environment Variables](stepbystep/configuration/configuring-through-environment-variables.md)
-    * [Data Input And Output](stepbystep/configuration/data-input-and-output/README.md)
-      * [Input Data](stepbystep/configuration/data-input-and-output/data.md)
-      * [Output](stepbystep/configuration/data-input-and-output/output.md)
-    * [Field Definitions](stepbystep/configuration/field-definitions.md)
-    * [Standardise Postprocessor](StandardisePostprocessor.md)
-    * [User Defined Mapping Match Types](stepbystep/configuration/adv-matchtypes.md)
-    * [Deterministic Matching](deterministicMatching.md)
-    * [Pass Through Data](passthru.md)
-    * [Model Location](stepbystep/configuration/model-location.md)
-    * [Tuning Label, Match And Link Jobs](stepbystep/configuration/tuning-label-match-and-link-jobs.md)
-    * [Telemetry](stepbystep/configuration/telemetry.md)
-  * [Working With Training Data](setup/training/createTrainingData.md)
-    * [Finding Records For Training Set Creation](setup/training/findTrainingData.md)
-    * [Labeling Records](setup/training/label.md)
-    * [Find And Label](setup/training/findAndLabel.md)
-    * [Using Pre-existing Training Data](setup/training/addOwnTrainingData.md)
-    * [Updating Labeled Pairs](updatingLabels.md)
-    * [Documenting The Training Data](stepbystep/createtrainingdata/generatingdocumentation.md)
-    * [Model Difference](stepbystep/createtrainingdata/modeldiff.md)
-  * [Ensuring Scalability](verifyBlocking.md)
-  * [Building And Saving The Model](setup/train.md)
-  * [Finding The Matches](setup/match.md)
-  * [Adding Incremental Data](runIncremental.md)
-  * [Linking Across Datasets](setup/link.md)
-  * [Lookup Data](lookup.md)
-  * [Approval of Clusters](approval.md)
-  * [Reassign ZINGG ID](reassignZinggId.md)
-* [Data Sources and Sinks](dataSourcesAndSinks/connectors.md)
-  * [Zingg Pipes](dataSourcesAndSinks/pipes.md)
-  * [Databricks](dataSourcesAndSinks/databricks.md)
-  * [Microsoft Fabric](dataSourcesAndSinks/fabric.md)
-  * [Snowflake](dataSourcesAndSinks/snowflake.md)
-  * [JDBC](dataSourcesAndSinks/jdbc.md)
-    * [Postgres](connectors/jdbc/postgres.md)
-    * [MySQL](connectors/jdbc/mysql.md)
-  * [AWS S3](dataSourcesAndSinks/amazonS3.md)
-  * [Cassandra](dataSourcesAndSinks/cassandra.md)
-  * [MongoDB](dataSourcesAndSinks/mongodb.md)
-  * [Neo4j](dataSourcesAndSinks/neo4j.md)
-  * [Parquet](dataSourcesAndSinks/parquet.md)
-  * [BigQuery](dataSourcesAndSinks/bigquery.md)
-  * [Exasol](dataSourcesAndSinks/exasol.md)
-* [Working With Python](working-with-python.md)
-  * [Community Python API](pythonOss/markdown/index.md)
-  * [Enterprise Python API](working-with-python-enterprise.md)
-    * [ZinggEC Python API](pythonEC/markdown/index.md)
-    * [ZinggES Python API](pythonES/markdown/index.md)
-* [Running Zingg On Cloud](running/running.md)
-  * [Running On AWS](running/aws.md)
-  * [Running On Azure](running/azure.md)
-  * [Running On Databricks](running/databricks.md)
-  * [Running on Fabric](running/running-on-fabric.md)
-* [Zingg Models](zModels.md)
-  * [Pre-Trained Models](pretrainedModels.md)
-* [Improving Accuracy](improving-accuracy/README.md)
-  * [Ignoring Commonly Occuring Words While Matching](accuracy/stopWordsRemoval.md)
-  * [Defining Domain Specific Blocking And Similarity Functions](accuracy/definingOwn.md)
-* [Interpreting Output Scores](scoring.md)
-* [Explanation of Matches](explainoutput/README.md)
-  * [Which records matched with each other in a cluster](explainoutput/which-records-matched-with-each-other-in-a-cluster.md)
-  * [Output Statistics](explainoutput/stats/README.md)
-    * [Configuring Output Statistics](explainoutput/stats/configuring-output-statistics.md)
-    * [Cluster Statistics](explainoutput/stats/cluster-statistics.md)
-    * [Record Statistics](explainoutput/stats/record-statistics.md)
-    * [Summary Statistics](explainoutput/stats/summary-statistics.md)
-* [Combining Different Match Models](relations.md)
-* [Reporting Bugs And Contributing](contributing.md)
-  * [Setting Up Zingg Development Environment](settingUpZingg.md)
-    * [macOS Setup Guide](macOSSetup.md)
-    * [Ubuntu/WSL2 Setup Guide](ubuntuSetup.md)
-* [Community](community.md)
-* [Frequently Asked Questions](faq.md)
-* [Reading Material](reading.md)
-* [Security And Privacy](security.md)
+## Zingg Concepts
+
+* [What is Zingg](README.md)
+* [Entity Resolution](zingg-concepts/entity-resolution/README.md)
+  * [Deterministic vs Probabilistic Matching](zingg-concepts/entity-resolution/deterministic-vs-probabilistic-matching.md)
+* [Community vs Enterprise](zingg-concepts/community-vs-enterprise/README.md)
+  * [Migrating from Community to Enterprise (Content to be Added)](zingg-concepts/community-vs-enterprise/migrating-from-community-to-enterprise-content-to-be-added.md)
+* [How Zingg Learns](zingg-concepts/how-zingg-learns/README.md)
+  * [Zingg Models](zingg-concepts/how-zingg-learns/zingg-models/README.md)
+    * [Blocking Model](zingg-concepts/how-zingg-learns/zingg-models/blocking-model.md)
+    * [Similarity Model](zingg-concepts/how-zingg-learns/zingg-models/similarity-model.md)
+    * [Standardize Fields and Results](zingg-concepts/how-zingg-learns/zingg-models/standardize-fields-and-results.md)
+  * [Match Types](zingg-concepts/how-zingg-learns/match-types/README.md)
+    * [FUZZY Match](zingg-concepts/how-zingg-learns/match-types/fuzzy-match.md)
+    * [FUZZY\_OPTIMISED Match](zingg-concepts/how-zingg-learns/match-types/fuzzy_optimised-match.md)
+    * [EXACT Match](zingg-concepts/how-zingg-learns/match-types/exact-match.md)
+    * [EMAIL Match](zingg-concepts/how-zingg-learns/match-types/email-match.md)
+    * [EMAIL\_OPTIMISED Match](zingg-concepts/how-zingg-learns/match-types/email_optimised-match.md)
+    * [PINCODE Match](zingg-concepts/how-zingg-learns/match-types/pincode-match.md)
+    * [NUMERIC Match](zingg-concepts/how-zingg-learns/match-types/numeric-match.md)
+    * [NUMERIC\_WITH\_UNITS Match](zingg-concepts/how-zingg-learns/match-types/numeric_with_units-match.md)
+    * [TEXT Match](zingg-concepts/how-zingg-learns/match-types/text-match.md)
+    * [ONLY\_ALPHABETS\_EXACT Match](zingg-concepts/how-zingg-learns/match-types/only_alphabets_exact-match.md)
+    * [ONLY\_ALPHABETS\_FUZZY Match](zingg-concepts/how-zingg-learns/match-types/only_alphabets_fuzzy-match.md)
+    * [ONLY\_ALPHABETS\_FUZZY\_OPTIMISED Match](zingg-concepts/how-zingg-learns/match-types/only_alphabets_fuzzy_optimised-match.md)
+    * [NULL\_OR\_BLANK Match](zingg-concepts/how-zingg-learns/match-types/null_or_blank-match.md)
+    * [DONT\_USE Match](zingg-concepts/how-zingg-learns/match-types/dont_use-match.md)
+    * [MAPPING\_(FILENAME) Match](zingg-concepts/how-zingg-learns/match-types/mapping_-filename-match.md)
+* [Identity Graph](zingg-concepts/identity-graph.md)
+* [Z Cluster and Zingg ID](zingg-concepts/z-cluster-and-zingg-id.md)
+* [Pass Through](zingg-concepts/pass-through.md)
+* [Concept Glossary](zingg-concepts/concept-glossary.md)
+
+## Running Zingg
+
+* [Step-by-Step Guide](running-zingg/step-by-step-guide.md)
+* [Experience Zingg](running-zingg/experience-zingg.md)
+* [Quick Start (Docker)](running-zingg/quick-start-docker.md)
+* [Install Zingg](running-zingg/install-zingg.md)
+* [Configure Zingg](running-zingg/configure-zingg.md)
+* [Create Training Data](running-zingg/create-training-data.md)
+* [Label Training Pairs](running-zingg/label-training-pairs.md)
+* [Verify Blocking](running-zingg/verify-blocking.md)
+* [Generate Model Documentation](running-zingg/generate-model-documentation.md)
+* [Build and Save the Model](running-zingg/build-and-save-the-model.md)
+* [Run the match phase](running-zingg/run-the-match-phase.md)
+* [Link across Datasets](running-zingg/link-across-datasets.md)
+* [Run Incremental Matching](running-zingg/run-incremental-matching.md)
+* [Reassign Zingg ID](running-zingg/reassign-zingg-id.md)
+* [Lookup Data](running-zingg/lookup-data.md)
+* [Cluster Approval](running-zingg/cluster-approval.md)
+* [Compare Model Results](running-zingg/compare-model-results.md)
+* [Knowledge Graph](running-zingg/knowledge-graph.md)
+
+## Connect Your Data
+
+* [Pipes and Data Connections](connect-your-data/pipes-and-data-connections.md)
+* [Connect Cloud Warehouses](connect-your-data/connect-cloud-warehouses/README.md)
+  * [Connect Azure Databricks](connect-your-data/connect-cloud-warehouses/connect-azure-databricks.md)
+  * [Connect Snowflake](connect-your-data/connect-cloud-warehouses/connect-snowflake.md)
+  * [Connect BigQuery](connect-your-data/connect-cloud-warehouses/connect-bigquery.md)
+  * [Connect Redshift](connect-your-data/connect-cloud-warehouses/connect-redshift.md)
+  * [Connect Microsoft Fabric](connect-your-data/connect-cloud-warehouses/connect-microsoft-fabric.md)
+  * [Connect Exasol](connect-your-data/connect-cloud-warehouses/connect-exasol.md)
+* [Connect Cloud Storage](connect-your-data/connect-cloud-storage.md)
+* [Connect File Formats](connect-your-data/connect-file-formats.md)
+* [Connect Relational Databases](connect-your-data/connect-relational-databases.md)
+* [Connect NoSQL Databases](connect-your-data/connect-nosql-databases.md)
+* [Connect Graph Databases (Neo4j)](connect-your-data/connect-graph-databases-neo4j.md)
+
+## Zingg Python API
+
+* [Working with Python](zingg-python-api/working-with-python.md)
+* [Community Python API](zingg-python-api/community-python-api.md)
+* [Enterprise ZinggEC Python API](zingg-python-api/enterprise-zinggec-python-api.md)
+* [Enterprise ZinggES Python API](zingg-python-api/enterprise-zingges-python-api.md)
+
+## Tuning
+
+* [Configure Field Standardization](tuning/configure-field-standardization.md)
+* [Improve Accuracy](tuning/improve-accuracy/README.md)
+  * [Remove Stopwords (Optional)](tuning/improve-accuracy/remove-stopwords-optional.md)
+* [Custom Blocking and Similarity](tuning/custom-blocking-and-similarity.md)
+
+## Interpreting Results
+
+* [Interpret Output Scores](interpreting-results/interpret-output-scores.md)
+* [Explain Matches](interpreting-results/explain-matches.md)
+* [Explain a Specific Cluster](interpreting-results/explain-a-specific-cluster.md)
+* [Output Statistics](interpreting-results/output-statistics.md)
+
+## Platform Guides
+
+* [Platform Guide for Azure Databricks](platform-guides/platform-guide-for-azure-databricks.md)
+* [Platform Guide for Microsoft Fabric](platform-guides/platform-guide-for-microsoft-fabric.md)
+* [Platform Guide for AWS EMR](platform-guides/platform-guide-for-aws-emr.md)
+* [Platform Guide for AWS GLUE](platform-guides/platform-guide-for-aws-glue.md)
+* [Platform Guide for GCP Dataproc](platform-guides/platform-guide-for-gcp-dataproc.md)
+* [Platform Guide for Snowflake](platform-guides/platform-guide-for-snowflake.md)
+
+## Recipes and Integration
+
+* [Identity RAG with Zingg and LangChain](recipes-and-integration/identity-rag-with-zingg-and-langchain.md)
+* [Combine Match Models](recipes-and-integration/combine-match-models.md)
+* [Pre-trained Models](recipes-and-integration/pre-trained-models.md)
+
+## Reference
+
+* [Configuration Schema](reference/configuration-schema.md)
+* [Zingg Command Line](reference/zingg-command-line.md)
+* [CLI Command Reference](reference/cli-command-reference.md)
+* [Runtime Properties](reference/runtime-properties.md)
+* [Hardware Sizing and Benchmarks](reference/hardware-sizing-and-benchmarks.md)
+* [Reading Material](reference/reading-material.md)
+
+## Contributing
+
+* [Contributing to Zingg](contributing/contributing-to-zingg.md)
+* [Setting Up Zingg Development Environment](contributing/setting-up-zingg-development-environment/README.md)
+  * [macOS Setup Guide](contributing/setting-up-zingg-development-environment/macos-setup-guide.md)
+  * [Ubuntu/WSL2 Setup Guide](contributing/setting-up-zingg-development-environment/ubuntu-wsl2-setup-guide.md)
+
+## Frequently Asked Questions
+
+* [Frequently Asked Questions](frequently-asked-questions/frequently-asked-questions.md)
+
+## Security and Privacy
+
+* [Security and Privacy](security-and-privacy/security-and-privacy.md)
+* [Telemetry and Usage Metrics](security-and-privacy/telemetry-and-usage-metrics.md)