diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx
index 118ee432..b7b75d6e 100644
--- a/.storybook/preview.tsx
+++ b/.storybook/preview.tsx
@@ -96,7 +96,8 @@ const preview: Preview = {
options: {
storySort: {
order: [
- "Introduction",
+ "Overview",
+ "Installation",
"Helpers",
"Theme",
"Theme/Logos",
diff --git a/src/storybook/Introduction.mdx b/src/storybook/Installation.mdx
similarity index 73%
rename from src/storybook/Introduction.mdx
rename to src/storybook/Installation.mdx
index 71137716..41f1384e 100644
--- a/src/storybook/Introduction.mdx
+++ b/src/storybook/Installation.mdx
@@ -1,19 +1,31 @@
-import packageJson from "../../package.json"
+import packageJson from "../../package.json";
import { Meta } from "@storybook/blocks";
-
+
+
+
+
+
- # Scientific React UI - v{packageJson.version}
+ # SciReactUI - v{packageJson.version}
## Introduction
- SciReactUI is a collection of useful scientific focused components which utilizing Material UI
- to make your React based websites look great.
+ SciReactUI provides the implementation package for Diamond Design System.
- Check out the list of components on the left. To use them, follow the instructions below.
+ Use this page to install the package, add the theme provider, and start using components in a React application.
+
@@ -30,8 +42,9 @@ import { Meta } from "@storybook/blocks";
### Next, Add a ThemeProvider
- Select a theme, either `GenericTheme` or `DiamondTheme` (Or you can create your own, see below), and add
- it to the App via the ThemeProvider:
+ Select theme `DiamondDSTheme` (or `GenericTheme`), and add it to the App via the ThemeProvider.
+
+ Alternatively, you can fork an existing theme or create your own (see below).
```tsx filename="main.tsx"
import {
@@ -111,8 +124,8 @@ import { Meta } from "@storybook/blocks";
}
```
-
+
@@ -151,4 +164,20 @@ import { Meta } from "@storybook/blocks";
on GitHub.
+
+
+ ## Adapting the Diamond DS Theme
+
+ The Diamond DS theme is a semantic layer built on top of MUI. It separates component behaviour from fixed Diamond colours, so the same theme structure can be reused with a different palette.
+
+ The important part is the role tokens. If your CSS defines the same role variables, the components will continue to work with your new colours.
+
+ To customise the theme, copy `DiamondDSTheme` and `diamond-ds-roles.css`, then rename both for your project. In your copied CSS file, keep the same token names and replace the colour values with your own palette.
+
+ For example, within the CSS file you can change `--ds-primary: #2a4db8;` to your desired primary colour.
+
+
+
+
+
diff --git a/src/storybook/Overview.mdx b/src/storybook/Overview.mdx
new file mode 100644
index 00000000..45b4fb15
--- /dev/null
+++ b/src/storybook/Overview.mdx
@@ -0,0 +1,55 @@
+import { Meta } from "@storybook/blocks";
+
+
+
+
+
+
+
+# Diamond Design System ❖
+
+
+ The design system for Diamond Light Source, providing a shared foundation for
+ building clear, consistent, reliable, and predictable scientific interfaces.
+
+
+## What the design system includes
+
+
+ - Reusable MUI-based components adapted for scientific workflows.
+ - Semantic theme roles and design tokens.
+ - Practical guidance for hierarchy, interaction, feedback, and layout.
+ - Shared patterns for operational and data-heavy interfaces.
+
+
+## What it helps us do
+
+
+ - Create clearer, more predictable scientific interfaces.
+ - Bring consistency across tools and beamlines.
+ - Reduce cognitive load in complex workflows.
+ - Speed up development with reusable components.
+ - Ensure new tools start coherent and stay aligned.
+
+
+## Principles
+
+The system focuses on:
+
+
+ - Clarity over decoration
+ - Predictability over novelty
+ - Semantic structure over one-off styling
+ - Accessibility and operational confidence
+ - Reusable patterns over local solutions
+
+
+