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

[Site refactor] Documentation update #439

Merged
merged 11 commits into from
Oct 4, 2023

Conversation

josepmartins
Copy link
Contributor

@josepmartins josepmartins commented Oct 2, 2023

Summary

This PR updates image examples in the design guidelines regarding the latest Typographic and border radius scale changes. This affects a list of component like Hero, River, CTABanners, etc.

This is part of the documentation update issue: https://github.com/github/primer/issues/2620

List of notable changes:

  • updated Label image examples
  • updated FAQ image examples
  • updated CTABanner image examples
  • updated CTAForm image examples
  • updated Grid image examples and layout
  • updated Heading image examples
  • updated River image examples

What should reviewers focus on?

Documentation is updated with latest site refactor designs.

Preview: https://primer-e6cc30237b-26139705.drafts.github.io/components/CTABanner

Supporting resources (related issues, external links, etc):

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • New visual snapshots have been generated / updated for any UI changes
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change

Screenshots:

Please try to provide before and after screenshots or videos

Before After

@changeset-bot
Copy link

changeset-bot bot commented Oct 2, 2023

⚠️ No Changeset found

Latest commit: a50b8eb

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@josepmartins josepmartins changed the title Josepmartins/docs fix examples Docs image examples Oct 2, 2023
@josepmartins josepmartins self-assigned this Oct 2, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

🟢 No design token changes found

@josepmartins josepmartins temporarily deployed to github-pages October 2, 2023 16:49 — with GitHub Actions Inactive
@github-actions
Copy link
Contributor

github-actions bot commented Oct 2, 2023

⚠️ Visual differences found

Our visual comparison tests found UI differences.

Please review the differences by using the test artifacts to ensure that the changes were intentional.

Artifacts can be downloaded and reviewed locally.

Download links are available at the bottom of the workflow summary screen.

Example:

artifacts section of workflow run

If the changes are expected, please run npm run test:visual:update-snapshots to replace the previous fixtures.

Review visual differences

@josepmartins josepmartins temporarily deployed to github-pages October 3, 2023 06:48 — with GitHub Actions Inactive
@josepmartins josepmartins temporarily deployed to github-pages October 3, 2023 07:17 — with GitHub Actions Inactive
@josepmartins josepmartins temporarily deployed to github-pages October 3, 2023 07:45 — with GitHub Actions Inactive
@josepmartins josepmartins marked this pull request as ready for review October 3, 2023 08:21
@josepmartins josepmartins changed the title Docs image examples [Site refactor] Documentation image examples update Oct 3, 2023
@josepmartins josepmartins temporarily deployed to github-pages October 3, 2023 08:28 — with GitHub Actions Inactive
@josepmartins josepmartins changed the title [Site refactor] Documentation image examples update [Site refactor] Documentation update Oct 3, 2023

![](https://github.com/primer/brand/assets/912236/78a81f0e-55d5-4db5-8a8b-3184394fac51)

#### Profile cards
Copy link
Collaborator

Choose a reason for hiding this comment

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

These don't visually appear like headings, which is presumably a theme limitation. Can we make this a h3 instead and bump up each preceding heading?

Screenshot 2023-10-03 at 11 44 05

Copy link
Contributor Author

@josepmartins josepmartins Oct 4, 2023

Choose a reason for hiding this comment

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

I think I rather adjust the styles in Doctocat than bumping each upper level heading, as this section deserves 3 levels at least 👍

Copy link
Collaborator

@rezrah rezrah left a comment

Choose a reason for hiding this comment

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

Looks good, left some feedback / suggestions but pre-emptively approving to help move it along 👍

Copy link
Contributor

@auareyou auareyou left a comment

Choose a reason for hiding this comment

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

Added a couple of comments out of curiosity but everything looks good.

@josepmartins josepmartins temporarily deployed to github-pages October 4, 2023 06:52 — with GitHub Actions Inactive
@josepmartins josepmartins merged commit c6ff540 into main Oct 4, 2023
@josepmartins josepmartins deleted the josepmartins/docs-fix-examples branch October 4, 2023 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants