diff --git a/apps/docs/CONTRIBUTING.md b/apps/docs/CONTRIBUTING.md index fac90e1aa47..41cb00108b4 100644 --- a/apps/docs/CONTRIBUTING.md +++ b/apps/docs/CONTRIBUTING.md @@ -191,8 +191,7 @@ Choose the appropriate `type` for your admonition: - `danger`: Warn about actions or conditions that could cause data loss, expose sensitive data, or create another severe and difficult-to-reverse outcome. State the consequence first, and then explain how to avoid it. - `deprecation`: Identify a deprecated feature or behavior. State how the change affects the reader, and then provide the supported alternative or migration path. - `caution`: Warn about behavior that could cause bugs, failed operations, unexpected results, or serious inconvenience but doesn't rise to the severity of `danger`. -- `tip`: Share an optional shortcut, optimization, or best practice that helps the reader complete the task more effectively. The main procedure must still work without it. -- `note`: Highlight an important prerequisite, constraint, or clarification that doesn't represent a risk. If the information is essential to completing a step, include it in the procedure instead. +- `note`: Highlight an important prerequisite, constraint, clarification, or optional shortcut that doesn't represent a risk. If the information is essential to completing a step, include it in the procedure instead. ``` diff --git a/apps/docs/app/contributing/content.mdx b/apps/docs/app/contributing/content.mdx index 12d02b26a59..a310714f4a3 100644 --- a/apps/docs/app/contributing/content.mdx +++ b/apps/docs/app/contributing/content.mdx @@ -75,12 +75,11 @@ For content that requires progressive disclosure: ### Admonition -For extra information that doesn't fit into the main flow. There are 5 supported types of admonitions: +For extra information that doesn't fit into the main flow, you can use the following types of admonitions: - `danger` to warn the user about any missteps that could cause data loss or data leaks - `deprecation` to notify the user about features that are (or will soon be) deprecated - `caution` to warn about anything that could cause a bug or serious user inconvenience -- `tip` to point out helpful but optional actions - `note` for anything else Leave a blank line between the admonition tag and the contained content. This will prevent Prettier from trying to break the lines within the content. @@ -104,15 +103,9 @@ You should make sure you don't set this up wrong. - - -In certain cases, you may want to do this. - - - -Additional helpful information. +In certain cases, you may want to do this. ``` @@ -135,15 +128,9 @@ You should make sure you don't set this up wrong. - - -In certain cases, you may want to do this. - - - -Additional helpful information. +In certain cases, you may want to do this. diff --git a/apps/docs/components/WrapperDashboardIntegration.tsx b/apps/docs/components/WrapperDashboardIntegration.tsx index 4e423f93b2a..d48058c51b1 100644 --- a/apps/docs/components/WrapperDashboardIntegration.tsx +++ b/apps/docs/components/WrapperDashboardIntegration.tsx @@ -4,7 +4,7 @@ import { Admonition } from 'ui-patterns/Admonition' export function WrapperDashboardIntegration({ title, path }: { title: string; path: string }) { return ( - +

You can enable the {title} wrapper right from the Supabase dashboard.