Skip to content

Adding glossary plugin#1713

Merged
pzaichkina merged 2 commits into
codatio:mainfrom
mcclowes:feat/glossary
Dec 16, 2025
Merged

Adding glossary plugin#1713
pzaichkina merged 2 commits into
codatio:mainfrom
mcclowes:feat/glossary

Conversation

@mcclowes
Copy link
Copy Markdown
Contributor

@mcclowes mcclowes commented Dec 15, 2025

@pzaichkina Plugin I built which is like the old terminology stuff we had. Feel free to use, just have a look and expand on the defined terms.


Note

Adds the glossary plugin to Docusaurus, configures it at /glossary, and introduces an initial glossary dataset.

  • Docusaurus config:
    • Switch preset to docusaurus-plugin-glossary/preset and configure glossary with glossary/glossary.json and route /glossary in docusaurus.config.js.
  • Content:
    • Add glossary/glossary.json containing initial terms (API, Connection, Company, Data source, Webhook, Sync, SMB, Bank Feeds, Link, REST).
  • Dependencies:
    • Add docusaurus-plugin-glossary to package.json.

Written by Cursor Bugbot for commit edf7f0d. This will update automatically on new commits. Configure here.

@vercel
Copy link
Copy Markdown

vercel Bot commented Dec 15, 2025

@mcclowes is attempting to deploy a commit to the Codat Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR is being reviewed by Cursor Bugbot

Details

Your team is on the Bugbot Free tier. On this plan, Bugbot will review limited PRs each billing cycle for each member of your team.

To receive Bugbot reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

Comment thread glossary/glossary.json
{
"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"]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: Related term references non-existent glossary entry

The "Data source" term's relatedTerms array includes "Integration", but no term with that name is defined in the glossary. This orphaned reference could result in broken links or rendering errors when the glossary plugin attempts to display related terms, depending on how the plugin handles missing references.

Fix in Cursor Fix in Web

Comment thread docusaurus.config.js
presets: [
[
"classic",
"docusaurus-plugin-glossary/preset",
Copy link
Copy Markdown

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.

Fix in Cursor Fix in Web

@vercel
Copy link
Copy Markdown

vercel Bot commented Dec 15, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
codat-docs Ready Ready Preview, Comment Dec 16, 2025 1:41pm

@pzaichkina pzaichkina enabled auto-merge December 16, 2025 13:38
@pzaichkina pzaichkina merged commit 9565e75 into codatio:main Dec 16, 2025
1 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants