Skip to content

Commit

Permalink
Create a guides section and put "For designers" into that
Browse files Browse the repository at this point in the history
  • Loading branch information
domyen committed Dec 14, 2023
1 parent af52867 commit 525a495
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 7 deletions.
1 change: 1 addition & 0 deletions src/components/Navigation/Navigation.astro
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ interface Props {
| CollectionEntry<"plugins">
| CollectionEntry<"ci">
| CollectionEntry<"account">
| CollectionEntry<"guides">
)[];
defaultOpen?: boolean;
timeline?: boolean;
Expand Down
1 change: 1 addition & 0 deletions src/components/Navigation/SideNav.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ type Item = (
| CollectionEntry<"plugins">
| CollectionEntry<"ci">
| CollectionEntry<"account">
| CollectionEntry<"guides">
) & {
data: {
sidebar: {
Expand Down
6 changes: 6 additions & 0 deletions src/content/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,11 @@ const account = defineCollection({
schema,
});

const guides = defineCollection({
type: "content",
schema,
});

export const collections = {
getStarted,
workflow,
Expand All @@ -67,4 +72,5 @@ export const collections = {
plugins,
ci,
account,
guides,
};
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
layout: "../../layouts/Layout.astro"
title: Guide for reviewers
description: How to use Chromatic for designers and product managers
sidebar: { order: 3 }
title: For designers
description: How to use Chromatic for designers
sidebar: { order: 1 }
---

# Guide for reviewers
# Guide for designers

Chromatic is made for designers, product managers, and other stakeholders to collaborate with developers.
Chromatic helps designers collaborate with developers on UI implementation.

## Chromatic in the design and product process
## In the design process

Chromatic serves as a library that maps every part of your UI. Use it as a shared reference point to ensure that everyone is referencing the latest UI as they design and spec products.

Expand All @@ -31,7 +31,7 @@ During the specification process, you often need to describe complex UI behavior

---

## Chromatic to track changes and sign-off
## Track changes and sign-off on implementation

[UI Review](/docs/review) is made for designers and product managers. It's a purpose-built tool for discussing implementation details and tracking sign-offs. Chromatic works behind the scenes to make the review process easy for teams by organizing change requests, notifying participants, and syncing with Git providers for pull requests checks. The key features for reviewers are:

Expand Down
6 changes: 6 additions & 0 deletions src/layouts/Layout.astro
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ const collaborate = await getCollection("collaborate");
const plugins = await getCollection("plugins");
const ci = await getCollection("ci");
const account = await getCollection("account");
const guides = await getCollection("guides");
const navItems = [
// Manually add the introduction page to the top of the list
Expand All @@ -42,6 +43,7 @@ const navItems = [
title: "Workflow",
items: workflow,
defaultOpen: true,
timeline: true,
},
{
title: "Configuration",
Expand Down Expand Up @@ -71,6 +73,10 @@ const navItems = [
title: "Account",
items: account,
},
{
title: "Guides",
items: guides,
},
];
const baseUrl = import.meta.env.BASE_URL;
Expand Down
2 changes: 2 additions & 0 deletions src/pages/[slug].astro
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export async function getStaticPaths() {
const plugins = await getCollection("plugins");
const ci = await getCollection("ci");
const account = await getCollection("account");
const guides = await getCollection("guides");
const notInNavigation = await getCollection("notInNavigation");
const articles = [
...getStarted,
Expand All @@ -25,6 +26,7 @@ export async function getStaticPaths() {
...plugins,
...ci,
...account,
...guides,
...notInNavigation,
];
return articles.map((article) => ({
Expand Down

0 comments on commit 525a495

Please sign in to comment.