diff --git a/.vscode/settings.json b/.vscode/settings.json
index 281d281..fb7494f 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -1,6 +1,6 @@
{
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
- "source.fixAll.stylelint": true
+ "source.fixAll.stylelint": "explicit"
}
}
diff --git a/src/404.webc b/src/404.webc
index 6daadb4..56eb52e 100644
--- a/src/404.webc
+++ b/src/404.webc
@@ -24,7 +24,7 @@ description: Page not found
Check the ceiling: Diamonds are often found on the ceiling of caves
- If you're looking for Diamond UI, try the docs.
+ If you're looking for Diamond UI, try the docs.
@@ -47,7 +47,7 @@ description: Page not found
-
+
Documentation
Guidance on how to get started and use Diamond UI on your next project.
diff --git a/src/about.webc b/src/about.webc
index 8e0656a..8f86b3e 100644
--- a/src/about.webc
+++ b/src/about.webc
@@ -27,8 +27,8 @@ description: The origin story of Diamond UI
I am re-using it! Interface styles can be grouped into four categories:
- content, controls, canvas
- and composition.
+ content, controls, canvas
+ and composition.
@@ -56,7 +56,7 @@ description: The origin story of Diamond UI
-
+
Documentation
Guidance on how to get started and use Diamond UI on your next project.
diff --git a/src/data/siteLinks.json b/src/data/siteLinks.json
index 1d4a9de..dc97c9a 100644
--- a/src/data/siteLinks.json
+++ b/src/data/siteLinks.json
@@ -4,8 +4,8 @@
"href": "/"
},
{
- "label": "Docs",
- "href": "/docs/"
+ "label": "Guide",
+ "href": "/guide/"
},
{
"label": "About",
diff --git a/src/docs/apply-diamond-ui/dark-mode-hero.webp b/src/guide/apply-diamond-ui/dark-mode-hero.webp
similarity index 100%
rename from src/docs/apply-diamond-ui/dark-mode-hero.webp
rename to src/guide/apply-diamond-ui/dark-mode-hero.webp
diff --git a/src/docs/apply-diamond-ui/hero-content.webp b/src/guide/apply-diamond-ui/hero-content.webp
similarity index 100%
rename from src/docs/apply-diamond-ui/hero-content.webp
rename to src/guide/apply-diamond-ui/hero-content.webp
diff --git a/src/docs/apply-diamond-ui/hero-with-eyebrow.webp b/src/guide/apply-diamond-ui/hero-with-eyebrow.webp
similarity index 100%
rename from src/docs/apply-diamond-ui/hero-with-eyebrow.webp
rename to src/guide/apply-diamond-ui/hero-with-eyebrow.webp
diff --git a/src/docs/apply-diamond-ui/hero-with-two-controls.webp b/src/guide/apply-diamond-ui/hero-with-two-controls.webp
similarity index 100%
rename from src/docs/apply-diamond-ui/hero-with-two-controls.webp
rename to src/guide/apply-diamond-ui/hero-with-two-controls.webp
diff --git a/src/docs/apply-diamond-ui/hero.webp b/src/guide/apply-diamond-ui/hero.webp
similarity index 100%
rename from src/docs/apply-diamond-ui/hero.webp
rename to src/guide/apply-diamond-ui/hero.webp
diff --git a/src/docs/apply-diamond-ui/index.webc b/src/guide/apply-diamond-ui/index.webc
similarity index 91%
rename from src/docs/apply-diamond-ui/index.webc
rename to src/guide/apply-diamond-ui/index.webc
index 3ae8343..866eb97 100644
--- a/src/docs/apply-diamond-ui/index.webc
+++ b/src/guide/apply-diamond-ui/index.webc
@@ -4,18 +4,18 @@ title: Apply Diamond UI
description: Designs can be broken up using the four Cs to separate component responsibilities.
tags: ['docs', 'Workflow']
icon: layers
-previous: /docs/composition/
-next: /docs/storybook-example/
+previous: /guide/composition/
+next: /guide/storybook-example/
date: 2024-10-01
---
-Let’s go right back to the start and look at our [page hero component](/docs/) again. Could we have done this differently with Diamond?
+Let’s go right back to the start and look at our [page hero component](/guide/) again. Could we have done this differently with Diamond?
@@ -28,7 +28,7 @@ Dividing this page hero component up into the four Cs we see it’s actually mad
@@ -50,7 +50,7 @@ Initially, this may appear to be quite a lot of components for such a small piec
@@ -76,7 +76,7 @@ We start to see here how composing individual components broken up by the four C
@@ -109,7 +109,7 @@ Now when the product team decide they need an email signup in the main hero or t
diff --git a/src/docs/canvas/canvas.webp b/src/guide/canvas/canvas.webp
similarity index 100%
rename from src/docs/canvas/canvas.webp
rename to src/guide/canvas/canvas.webp
diff --git a/src/docs/canvas/index.webc b/src/guide/canvas/index.webc
similarity index 94%
rename from src/docs/canvas/index.webc
rename to src/guide/canvas/index.webc
index 3dc675f..b236bc7 100644
--- a/src/docs/canvas/index.webc
+++ b/src/guide/canvas/index.webc
@@ -4,8 +4,8 @@ title: Canvas
description: A canvas represents a part of the page that content and controls sit within, they can provide padding and backgrounds for their content area.
tags: ['docs', 'Four Cs']
icon: canvas
-previous: /docs/controls/
-next: /docs/composition/
+previous: /guide/controls/
+next: /guide/composition/
date: 2024-10-03
---
@@ -23,7 +23,7 @@ Typical examples of canvas components are:
diff --git a/src/docs/comparison/atoms.webp b/src/guide/comparison/atoms.webp
similarity index 100%
rename from src/docs/comparison/atoms.webp
rename to src/guide/comparison/atoms.webp
diff --git a/src/docs/comparison/index.webc b/src/guide/comparison/index.webc
similarity index 98%
rename from src/docs/comparison/index.webc
rename to src/guide/comparison/index.webc
index e4c5aa2..f45cf54 100644
--- a/src/docs/comparison/index.webc
+++ b/src/guide/comparison/index.webc
@@ -4,7 +4,7 @@ title: Comparison
description: How does Diamond UI compare to some other popular methodologies and frameworks?
tags: ['docs', 'Workflow']
icon: connection
-previous: /docs/storybook-example/
+previous: /guide/storybook-example/
date: 2024-10-03
---
@@ -23,7 +23,7 @@ The smallest components are atoms. These are things like HTML elements, or other
@@ -33,7 +33,7 @@ Moving up from atoms, molecules are small groups of UI elements that bond togeth
@@ -42,7 +42,7 @@ Following this trend, organisms are larger groups of atoms and molecules. Organi
diff --git a/src/docs/comparison/input-button-group.webp b/src/guide/comparison/input-button-group.webp
similarity index 100%
rename from src/docs/comparison/input-button-group.webp
rename to src/guide/comparison/input-button-group.webp
diff --git a/src/docs/composition/composition.webp b/src/guide/composition/composition.webp
similarity index 100%
rename from src/docs/composition/composition.webp
rename to src/guide/composition/composition.webp
diff --git a/src/docs/composition/index.webc b/src/guide/composition/index.webc
similarity index 92%
rename from src/docs/composition/index.webc
rename to src/guide/composition/index.webc
index c7f459d..31daa1e 100644
--- a/src/docs/composition/index.webc
+++ b/src/guide/composition/index.webc
@@ -4,8 +4,8 @@ title: Composition
description: Compositions are an invisible element of the page that provides layout.
tags: ['docs', 'Four Cs']
icon: composition
-previous: /docs/canvas/
-next: /docs/apply-diamond-ui/
+previous: /guide/canvas/
+next: /guide/apply-diamond-ui/
date: 2024-10-04
---
@@ -21,7 +21,7 @@ Typical examples of a composition component are:
diff --git a/src/docs/content/content.webp b/src/guide/content/content.webp
similarity index 100%
rename from src/docs/content/content.webp
rename to src/guide/content/content.webp
diff --git a/src/docs/content/index.webc b/src/guide/content/index.webc
similarity index 94%
rename from src/docs/content/index.webc
rename to src/guide/content/index.webc
index 0bdd06f..f0a6052 100644
--- a/src/docs/content/index.webc
+++ b/src/guide/content/index.webc
@@ -4,8 +4,8 @@ title: Content
description: Content components look after the general styles for text and images, but can extend to data-specific patterns such as user profiles or product information.
tags: ['docs', 'Four Cs']
icon: content
-previous: /docs/the-solution/
-next: /docs/controls/
+previous: /guide/the-solution/
+next: /guide/controls/
date: 2024-10-01
---
@@ -22,7 +22,7 @@ Typical examples of content components are:
diff --git a/src/docs/controls/controls.webp b/src/guide/controls/controls.webp
similarity index 100%
rename from src/docs/controls/controls.webp
rename to src/guide/controls/controls.webp
diff --git a/src/docs/controls/index.webc b/src/guide/controls/index.webc
similarity index 93%
rename from src/docs/controls/index.webc
rename to src/guide/controls/index.webc
index 745a8c5..2b0721b 100644
--- a/src/docs/controls/index.webc
+++ b/src/guide/controls/index.webc
@@ -4,8 +4,8 @@ title: Controls
description: Controls are interactive elements of the page.
tags: ['docs', 'Four Cs']
icon: controls
-previous: /docs/content/
-next: /docs/canvas/
+previous: /guide/content/
+next: /guide/canvas/
date: 2024-10-02
---
@@ -21,7 +21,7 @@ Typical examples of controls are:
diff --git a/src/docs/storybook-example.webc b/src/guide/storybook-example.webc
similarity index 92%
rename from src/docs/storybook-example.webc
rename to src/guide/storybook-example.webc
index 88734b0..376aa06 100644
--- a/src/docs/storybook-example.webc
+++ b/src/guide/storybook-example.webc
@@ -4,8 +4,8 @@ title: Storybook example
description: Diamond components can be organised into the four Cs to make their responsibilities clear.
tags: ['docs', 'Workflow']
icon: book
-next: /docs/comparison/
-previous: /docs/apply-diamond-ui/
+next: /guide/comparison/
+previous: /guide/apply-diamond-ui/
date: 2024-10-02
---
diff --git a/src/docs/the-problem/hero.webp b/src/guide/the-problem/hero.webp
similarity index 100%
rename from src/docs/the-problem/hero.webp
rename to src/guide/the-problem/hero.webp
diff --git a/src/docs/the-problem/index.webc b/src/guide/the-problem/index.webc
similarity index 94%
rename from src/docs/the-problem/index.webc
rename to src/guide/the-problem/index.webc
index c0a0dee..cea2451 100644
--- a/src/docs/the-problem/index.webc
+++ b/src/guide/the-problem/index.webc
@@ -4,8 +4,8 @@ tags: ['docs', 'Getting started']
title: The problem
description: How do you create and organise components in a way that is scalable and maintainable over time?
icon: warning
-permalink: /docs/index.html
-next: /docs/the-solution/
+permalink: /guide/index.html
+next: /guide/the-solution/
---
@@ -14,7 +14,7 @@ Imagine you’ve been tasked with designing a page hero. Having no other context
@@ -42,7 +42,7 @@ A little while later a new request comes in for a slightly different hero &ndash
@@ -72,7 +72,7 @@ Over the months, more requirements come in and more props get added. Different t
diff --git a/src/docs/the-problem/max-hero.webp b/src/guide/the-problem/max-hero.webp
similarity index 100%
rename from src/docs/the-problem/max-hero.webp
rename to src/guide/the-problem/max-hero.webp
diff --git a/src/docs/the-problem/yellow-hero.webp b/src/guide/the-problem/yellow-hero.webp
similarity index 100%
rename from src/docs/the-problem/yellow-hero.webp
rename to src/guide/the-problem/yellow-hero.webp
diff --git a/src/docs/the-solution.webc b/src/guide/the-solution.webc
similarity index 94%
rename from src/docs/the-solution.webc
rename to src/guide/the-solution.webc
index 99a539b..d8d8e62 100644
--- a/src/docs/the-solution.webc
+++ b/src/guide/the-solution.webc
@@ -4,8 +4,8 @@ tags: ['docs', 'Getting started']
title: The solution
description: Cleanly separate responsibilities to create reusable, future friendly, components.
icon: tick
-previous: /docs/
-next: /docs/content/
+previous: /guide/
+next: /guide/content/
---
@@ -14,7 +14,7 @@ When you think about it, a component is a function that takes some parameters an
When writing code, a generally agreed-on principle is that a function should *do one thing*. This makes functions more readable, modular, and easy to maintain.
-Here’s our [page hero component](/docs/) as a function:
+Here’s our [page hero component](/guide/) as a function:
```js
function pageHero(
diff --git a/src/index.webc b/src/index.webc
index eb4a8e7..489fa40 100644
--- a/src/index.webc
+++ b/src/index.webc
@@ -349,7 +349,7 @@ description: Diamond UI is a methodology for teams who build software products a
-
+
Documentation
Guidance on how to get started and use Diamond UI on your next project.