docs: Add note for updated terminology (#11802)

# Which Problems Are Solved

For existing customers it could be hard to understand the new aligned
terms we have defined, if they are already used to the "old term"

# How the Problems Are Solved

Adding notes at the top of docs pages to state clearliy new and old
terms.
This commit is contained in:
Fabienne Bühler
2026-03-16 09:10:48 +00:00
committed by GitHub
parent cadf75e4fe
commit 9a4530bf77
15 changed files with 169 additions and 90 deletions
@@ -0,0 +1,23 @@
import { Callout } from 'fumadocs-ui/components/callout';
interface TermNoteProps {
newTerm: string;
oldTerms: string[];
}
export function TerminologyUpdate({ newTerm, oldTerms }: TermNoteProps) {
// Formats the list: "A, B and C"
const formattedOldTerms = oldTerms.map((term, i) => (
<b key={term}>
{term}{i < oldTerms.length - 2 ? ', ' : i === oldTerms.length - 2 ? ' or ' : ''}
</b>
));
return (
<Callout type="info">
<b>Terminology Update:</b> We have streamlined our naming conventions to improve clarity.
The term <b>{newTerm}</b> now replaces what was previously referred to as {formattedOldTerms}.
These terms all refer to the same underlying functionality.
</Callout>
);
}