Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workflow & Guides: Respond to more feedback #335

Merged
merged 6 commits into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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: 6 }
title: Chromatic for designers
description: How to use Chromatic for designers
sidebar: { order: 1, label: For designers }
---

# 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 All @@ -43,19 +43,3 @@ During the specification process, you often need to describe complex UI behavior
- UI checklist to see visualize what needs to be done

![UI Checklist](../../images/prscreen-ui-checklist.png)

---

## Conclusion

You finished touring all the ways Chromatic contributes to your UI development workflow. We look forward to the incredible UIs you’ll build. Continue exploring with our most popular guides and articles:

- [Intro to Storybook](https://storybook.js.org/tutorials/intro-to-storybook/) is the essential guide to learning Storybook.
- [Design Systems for Developers](https://storybook.js.org/tutorials/design-systems-for-developers/) shares how to build production infrastructure for design systems.
- [Visual Testing Handbook](https://storybook.js.org/tutorials/visual-testing-handbook/) details how professional frontend teams visual test with Storybook.
- [Component-Driven Development](https://www.componentdriven.org/) is a "bottoms up" process for building modular UIs starting from components and ending with screens.
- [UI Testing Handbook](https://storybook.js.org/tutorials/ui-testing-handbook/) highlights testing strategies used by scaled front-end teams

#### How to get support

[Sign in](https://www.chromatic.com/start) to use the in-app chat or <a href="mailto:[email protected]?Subject=Question">email support</a>.
4 changes: 2 additions & 2 deletions src/content/workflow/in-development.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: "../../layouts/Layout.astro"
title: In development
title: In development workflow
description: How Chromatic helps teams develop applications
sidebar: { order: 1 }
sidebar: { order: 1, label: In development }
---

# In development workflow
Expand Down
18 changes: 13 additions & 5 deletions src/content/workflow/in-pull-request.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: "../../layouts/Layout.astro"
title: In pull request
title: In pull request workflow
description: How Chromatic helps you test and review pull requests
sidebar: { order: 6 }
sidebar: { order: 2, label: In pull request }
---

# In pull request workflow
Expand Down Expand Up @@ -79,8 +79,16 @@ The status of UI Tests and UI Review appears on your pull request as a check. Th

---

## Next: How to get stakeholders involved in review
## Conclusion

See how Chromatic works from the reviewer point of view. Learn about comments, notifications, and integrations with tools like Figma and Slack.
You finished touring all the ways Chromatic contributes to your UI development workflow. We look forward to the incredible UIs you’ll build. Continue exploring with our most popular guides and articles:

<a class="btn primary round" href="/docs/guide-for-reviewers">Read next chapter</a>
- [Intro to Storybook](https://storybook.js.org/tutorials/intro-to-storybook/) is the essential guide to learning Storybook.
- [Design Systems for Developers](https://storybook.js.org/tutorials/design-systems-for-developers/) shares how to build production infrastructure for design systems.
- [Visual Testing Handbook](https://storybook.js.org/tutorials/visual-testing-handbook/) details how professional frontend teams visual test with Storybook.
- [Component-Driven Development](https://www.componentdriven.org/) is a "bottoms up" process for building modular UIs starting from components and ending with screens.
- [UI Testing Handbook](https://storybook.js.org/tutorials/ui-testing-handbook/) highlights testing strategies used by scaled front-end teams

#### How to get support

[Sign in](https://www.chromatic.com/start) to use the in-app chat or <a href="mailto:[email protected]?Subject=Question">email support</a>.
5 changes: 5 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 Down Expand Up @@ -72,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
Loading