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

Update documentation design with cypress design system #5572

Merged
merged 88 commits into from
Feb 2, 2024

Conversation

elevatebart
Copy link
Contributor

@elevatebart elevatebart commented Dec 7, 2023

Update the documentation template to match Cypress Brand

Copy link

netlify bot commented Dec 7, 2023

Deploy Preview for benevolent-cat-040f48 ready!

Name Link
🔨 Latest commit dbbe7b2
🔍 Latest deploy log https://app.netlify.com/sites/benevolent-cat-040f48/deploys/65bbec5daf657000078625bb
😎 Deploy Preview https://deploy-preview-5572--benevolent-cat-040f48.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@jaffrepaul jaffrepaul left a comment

Choose a reason for hiding this comment

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

I pushed a few changes to fix wonky content. There are still a few area that could use attention tho.

  • this was a quick visual to help try to describe the branch review UI, but it looks like the MDX version bump changed how nested lists render. it may be worth cooking up something better vs. trying to wrestle this into place https://share.cleanshot.com/6Y3Q0bLN
  • some tags are wrapped in a <p> if they have accompanying text and some don't. Ends up creating inconsistent spacing, sometimes across the same page https://share.cleanshot.com/Wj1fwCRg
  • not sure if the design treatment changed, but seems like some admonition line height is more compressed than the figma https://share.cleanshot.com/7qyQ2gjJ (the color shouldn't change, just pointing out the whitespace)

@@ -4,15 +4,15 @@ div.markdown {

ul {
padding-left: var(--ifm-list-left-padding);
li {
Copy link
Contributor

Choose a reason for hiding this comment

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

For this, we'll still want the disc when a it's first child and circle when indented further.

This way not all bullets become circles like we have with this change as is:
https://share.cleanshot.com/3Mk98nzB

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh yeah, missed that.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed here d2ce38e

Copy link
Contributor

@jaffrepaul jaffrepaul left a comment

Choose a reason for hiding this comment

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

👍

@elevatebart elevatebart merged commit ce05e8f into main Feb 2, 2024
11 checks passed
@elevatebart elevatebart deleted the elevatebart/theme-docs-with-template branch February 2, 2024 12:50
@MikeMcC399
Copy link
Contributor

MikeMcC399 commented Feb 4, 2024

@elevatebart / @jaffrepaul

This PR leaves yarn.lock in an unsynchronized state after running npm install.

$ git diff
diff --git a/yarn.lock b/yarn.lock
index 97f95bb6..8dacd88f 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -4360,11 +4360,6 @@ fs.realpath@^1.0.0:
   resolved "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz"
   integrity sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==

-fsevents@~2.3.2:
-  version "2.3.3"
-  resolved "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz"
-  integrity sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==
-
 function-bind@^1.1.2:
   version "1.1.2"
   resolved "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz"

MikeMcC399 added a commit to MikeMcC399/cypress-documentation that referenced this pull request Feb 4, 2024
@elevatebart
Copy link
Contributor Author

Actually we should only have a package-lock here. The yarn.lock is superfluous...

@MikeMcC399
Copy link
Contributor

@elevatebart

Actually we should only have a package-lock here. The yarn.lock is superfluous...

If yarn.lock is not needed will you submit a PR to remove it? I was suspicious about seeing both package-lock.json and yarn.lock in the same top level directory, however I didn't have the confidence to remove it. I also didn't understand why npm install was causing changes in yarn.lock to be made. I have never met this situation before!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants