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

docs(fundamentals): fix example-row-detail positioning #1859

Merged
merged 3 commits into from
Nov 27, 2024

Conversation

dancormier
Copy link
Contributor

STACKS-657


This PR resolves positioning issues with the annotations used in color fundamentals docs page.

Before

image
image

After

image
image

How to test

  1. Spin this PR up locally (npm run start)
  2. Head to the Color Fundamentals page
  3. Verify that the annotations under each of the monochromatic color strips are positioned as expected
  4. Bonus: Since this fix necessitated changes to the accessibility docs code, verify that annotations under examples are positioned as expected

@dancormier dancormier added the docs Issues with the documentation site label Nov 22, 2024
@dancormier dancormier requested review from CGuindon and a team November 22, 2024 15:59
Copy link

netlify bot commented Nov 22, 2024

Deploy Preview for stacks ready!

Name Link
🔨 Latest commit 57789bc
🔍 Latest deploy log https://app.netlify.com/sites/stacks/deploys/6747891849a906000884c147
😎 Deploy Preview https://deploy-preview-1859--stacks.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

@giamir giamir left a comment

Choose a reason for hiding this comment

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

It looks good to me from a dev perspective.
I have only left a small thing to address in a comment.

@CGuindon can give a final thumbs up from a design perspective.

@@ -108,7 +108,7 @@
</button>
{% render 'example-row-detail.html',
text: group.description,
style: "margin-left: 50%;",
classes: "mx-auto",
customHeight: 16
Copy link
Contributor

Choose a reason for hiding this comment

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

Issue: Looking at the example-row-detail.html partial I think that what we called customHeight in this file should be called connectorHeight instead.

Sidenote (out of scope)
I think we could find a better name for this partial. It took me a while to understand what Example Row Detail even mean and I still have some doubt. Perhaps something likeannotation.html or connected-annotation.html could work at least based on its usage here. Thoughts?

Copy link
Contributor Author

@dancormier dancormier Nov 26, 2024

Choose a reason for hiding this comment

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

Issue: Looking at the example-row-detail.html partial I think that what we called customHeight in this file should be called connectorHeight instead.

Ah, nice catch! I've resolved this in this commit.

Sidenote (out of scope) I think we could find a better name for this partial. It took me a while to understand what Example Row Detail even mean and I still have some doubt. Perhaps something likeannotation.html or connected-annotation.html could work at least based on its usage here. Thoughts?

I agree. I think example-row-detail is one of those placeholder names that just accidentally became semi-permanent. I think annotation.html or example-annotation.html makes the sense to me (I'd argue against connected-annotation.html to keep the name tied to purpose as opposed to presentation).

I'll make a follow up PR for that to keep this PR focused. Thanks for the feedback.

Update: Here's the PR

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR, I have merged it now.
You might want to rebase this branch then. Hopefully there are not nasty conflicts to fix. 🤞

@dancormier dancormier merged commit 707796c into develop Nov 27, 2024
11 checks passed
@dancormier dancormier deleted the STACKS-657/example-row-detail-positioning branch November 27, 2024 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues with the documentation site
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants