add some clarification to types

aslilac · aslilac · commit c75e758369dc · 2024-08-20T16:27:11.000Z
diff --git a/site/src/theme/index.ts b/site/src/theme/index.ts
@@ -8,9 +8,18 @@ import type { ExternalImageModeStyles } from "./externalImages";
 import light from "./light";
 import type { Roles } from "./roles";
 
-export interface Theme extends MuiTheme {
-	experimental: NewTheme;
+export interface Theme extends Omit<MuiTheme, "palette"> {
+	/** @deprecated use `theme.roles` instead */
+	palette: MuiTheme["palette"];
+
+	/** Sets of colors that can be used based on the role that a UI element serves
+	 * for the user.
+	 * Does it signify an error? a warning? that something is currently running? etc.
+	 */
 	roles: Roles;
+
+	/** Theme properties that we're testing out but haven't committed to. */
+	experimental: NewTheme;
 	monaco: monaco.editor.IStandaloneThemeData;
 	externalImages: ExternalImageModeStyles;
 }
