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.

Sign up for GitHub

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

Jump to bottom

First pass at documenting layout components and patterns #1513

Merged
merged 4 commits into from
Jun 6, 2024
Merged

First pass at documenting layout components and patterns #1513

merged 4 commits into from
Jun 6, 2024

Conversation

jamesmockett
Copy link
Contributor

@jamesmockett jamesmockett commented Jun 5, 2024 •
edited
Loading

What are you changing?

  • Adds doc page to Source storybook to document layout components and show examples

Why?

  • The layout components in Source are not that widely used. This is an attempt to begin documenting them and show how they can be composed to create common layout patterns with consistent spacing

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jun 5, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: 7a8e280

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@jamesmockett jamesmockett self-assigned this Jun 5, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 5, 2024

Tip

Once this PR is ready to go, add the run_chromatic label to run the Chromatic tests.

This saves us a lot of money by not running the tests before we need them.

@github-actions github-actions bot added the 📦 npm Affects a @guardian package on NPM label Jun 5, 2024
@jamesmockett jamesmockett linked an issue Jun 5, 2024 that may be closed by this pull request
Add documentation for layouts and layout patterns #1499
Closed
@jamesmockett jamesmockett marked this pull request as ready for review June 6, 2024 08:43
@jamesmockett jamesmockett requested review from a team as code owners June 6, 2024 08:43
@jamesmockett jamesmockett added the run_chromatic Runs chromatic when label is applied label Jun 6, 2024
oliverabrahams
oliverabrahams approved these changes Jun 6, 2024
View reviewed changes
Copy link
Contributor

@oliverabrahams oliverabrahams left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. maybe one for the client side infra

@jamesmockett jamesmockett merged commit 7a1aa02 into main Jun 6, 2024
19 checks passed
@jamesmockett jamesmockett deleted the jm/layout-docs branch June 6, 2024 14:43
@jamesmockett
Copy link
Contributor Author

This is great. maybe one for the client side infra

The docs and some of the layout components need a little refinement still, but definitely something worth discussing in a future Client Side Meetup.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oliverabrahams oliverabrahams oliverabrahams approved these changes

Assignees

@jamesmockett jamesmockett

Labels
📦 npm Affects a @guardian package on NPM run_chromatic Runs chromatic when label is applied
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add documentation for layouts and layout patterns
2 participants
@jamesmockett @oliverabrahams