diff --git a/docusaurus.config.js b/docusaurus.config.js index 9719e9eb7..42b6cb3e1 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -53,9 +53,13 @@ const config = { presets: [ [ - "classic", + "docusaurus-plugin-glossary/preset", /** @type {import('@docusaurus/preset-classic').Options} */ ({ + glossary: { + glossaryPath: "glossary/glossary.json", + routePath: "/glossary", + }, docs: { routeBasePath: "/", sidebarPath: "./sidebars.js", diff --git a/glossary/glossary.json b/glossary/glossary.json new file mode 100644 index 000000000..51d51d7c6 --- /dev/null +++ b/glossary/glossary.json @@ -0,0 +1,57 @@ +{ + "description": "Codat terminology and key concepts", + "terms": [ + { + "term": "API", + "abbreviation": "Application Programming Interface", + "definition": "A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms.", + "relatedTerms": ["REST", "Webhook"] + }, + { + "term": "Connection", + "definition": "A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform.", + "relatedTerms": ["Company", "Data source"] + }, + { + "term": "Company", + "definition": "In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.", + "relatedTerms": ["Connection"] + }, + { + "term": "Data source", + "definition": "An external platform (such as QuickBooks, Xero, or a bank) that Codat integrates with to pull or push financial data.", + "relatedTerms": ["Connection", "Integration"] + }, + { + "term": "Webhook", + "definition": "An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status.", + "relatedTerms": ["API"] + }, + { + "term": "Sync", + "definition": "The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule.", + "relatedTerms": ["Connection", "Data source"] + }, + { + "term": "SMB", + "abbreviation": "Small and Medium-sized Business", + "definition": "The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million." + }, + { + "term": "Bank Feeds", + "definition": "A Codat product that enables automatic synchronization of bank transaction data into a company's accounting software.", + "relatedTerms": ["Sync"] + }, + { + "term": "Link", + "definition": "The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat.", + "relatedTerms": ["Connection", "Company"] + }, + { + "term": "REST", + "abbreviation": "Representational State Transfer", + "definition": "An architectural style for designing networked applications. Codat's APIs follow REST principles, using standard HTTP methods.", + "relatedTerms": ["API"] + } + ] +} diff --git a/package-lock.json b/package-lock.json index 19046af69..ea4c1a259 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20,6 +20,7 @@ "@stoplight/elements": "^8.4.6", "buffer": "^6.0.3", "clsx": "^2.1.1", + "docusaurus-plugin-glossary": "^3.0.0", "docusaurus-plugin-cookie-consent": "^4.1.0", "docusaurus-plugin-image-zoom": "^2.0.0", "docusaurus-plugin-module-alias": "^0.0.2", @@ -8785,6 +8786,23 @@ "node": ">=6" } }, + "node_modules/docusaurus-plugin-glossary": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/docusaurus-plugin-glossary/-/docusaurus-plugin-glossary-3.0.0.tgz", + "integrity": "sha512-3ifzU7xJ1im5vXiz/E4oZHkr2YM43yjEocGjnMuzWbZirNxtWqNd0IzQteC26zUN+YA+QkhgCr9GUb6w5HsKyA==", + "license": "MIT", + "dependencies": { + "fs-extra": "^11.0.0", + "unist-util-visit": "^5.0.0", + "validate-peer-dependencies": "^2.2.0" + }, + "engines": { + "node": ">=16.14" + }, + "peerDependencies": { + "@docusaurus/core": "^3.0.0", + "react": "^18.0.0", + "react-dom": "^18.0.0" "node_modules/docusaurus-plugin-cookie-consent": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/docusaurus-plugin-cookie-consent/-/docusaurus-plugin-cookie-consent-4.1.0.tgz", diff --git a/package.json b/package.json index 07be77907..93c54f7d5 100644 --- a/package.json +++ b/package.json @@ -37,6 +37,7 @@ "@stoplight/elements": "^8.4.6", "buffer": "^6.0.3", "clsx": "^2.1.1", + "docusaurus-plugin-glossary": "^3.0.0", "docusaurus-plugin-cookie-consent": "^4.1.0", "docusaurus-plugin-image-zoom": "^2.0.0", "docusaurus-plugin-module-alias": "^0.0.2",