This repository contains the contents of the Connect AI documentation. The documentation is powered by Mintlify.
The Connect AI documentation is organized as follows:
- The English documentation is in the
endirectory, while the Japanese documentation is in thejadirectory. - There are no subfolders for the documentation areas (Getting Started, Data Sources, etc.) as there were in the previous documentation repo. This is how the migration was delivered, and creating subfolders would cause issues with links. This may change in the future.
- The
endirectory andjadirectory each contain astyle.cssfile that contains adjustments from the default Mintlify template. Any style changes go here. You need astyle.cssfor each language. They are the same. - The
enandjadirectories each contain animagesdirectory. The images arepngfiles. - All Data Source files have a
Connect AIand anEmbeddedversion. This was necessary for the top-level navigation to work correctly. The Data Source files (Connect AI and Embedded versions) consist of a link to the same correspondingSnippetsfile. If a Data Source needs to be updated, it should be updated in the Snippets file. More on snippets below. - The Connect AI Integration files contain
-Clientat the end. The Embedded versions of Integration files are named with-Client-Embeddedat the end. They need to be updated separately, as they require different authentication. This affects some AI integrations and Dev Tools integrations. - The
logodirectory contains the light and dark mode versions of the CData logo. - The
snippetsdirectory contains reusable snippets for the documentation. This folder must be at the top level in order to work correctly (Mintlify may change this in the future). This directory contains anenandjafolder. There is aData-Sourcessubdirectory for each language. This contains the data source snippets that are referenced by the Connect AI and Embedded docs. There are other snippets for text that is repeated. - The
docs.jsonfile contains the global settings and the entire table of contents for the documentation website, including English and Japanese versions. More info here. Use Cursor or another AI tool to modify this file, as it is hard to manage. favicon.icois the favicon for the docs.