Adding glossary plugin #1713
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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"] | ||
|
There was a problem hiding this comment. Bug: Related term references non-existent glossary entryThe "Data source" term's |
||
| }, | ||
| { | ||
| "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"] | ||
| } | ||
| ] | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Bug: Replacing classic preset may break site functionality
The preset was changed from
"classic"to"docusaurus-plugin-glossary/preset", but the glossary plugin's package metadata shows it doesn't depend on or include@docusaurus/preset-classic. The configuration still passes classic preset options (docs,blog,theme,sitemap) which may be silently ignored by the glossary preset. This could cause the documentation, blog, theming, and sitemap functionality to stop working. The retained@type {import('@docusaurus/preset-classic').Options}comment further suggests this replacement may be unintentional.