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

Website Docs Visual Separation #1402

Merged
merged 12 commits into from
Jul 20, 2023
Merged

Website Docs Visual Separation #1402

merged 12 commits into from
Jul 20, 2023

Conversation

marashad001
Copy link
Contributor

@marashad001 marashad001 commented Jul 11, 2023

Changes

#941 - Adds visual separation in between different sections of demos to make them more distinct

Before:
Screenshot 2023-07-12 105400
Screenshot 2023-07-12 105926

After:
Screenshot 2023-07-12 111601
Screenshot 2023-07-12 111536

Testing

N/A (yet, maybe)

Docs

N/A (we're just making the docs look cleaner)

@marashad001 marashad001 changed the title initial push Website Docs Visual Separation Jul 11, 2023
@marashad001 marashad001 marked this pull request as ready for review July 12, 2023 14:49
@marashad001 marashad001 requested review from a team as code owners July 12, 2023 14:49
@marashad001 marashad001 requested review from mayank99 and LostABike and removed request for a team July 12, 2023 14:49
Copy link
Contributor

@mayank99 mayank99 left a comment

Choose a reason for hiding this comment

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

Can you use our css variables (--space-1, --space-2, etc) instead of magic numbers?

Also can you include "Before" vs "After" screenshots in PR description?

Copy link
Contributor

@LostABike LostABike left a comment

Choose a reason for hiding this comment

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

Does this change affect all the other pages? Or just the getting started page?

Also, just personal opinion but I think in this case h2 and h3 would look better with a smaller gap, something like this
image

@marashad001
Copy link
Contributor Author

Does this change affect all the other pages? Or just the getting started page?

Also, just personal opinion but I think in this case h2 and h3 would look better with a smaller gap, something like this image

Yes, it affects the entire doc website. I agree, I was having trouble coming up with a way to narrow the gap between h2 and h3. Do you have any suggestions for how this could be implemented?

@LostABike
Copy link
Contributor

https://github.com/iTwin/iTwinUI/blob/13518490f2bb926f4d0b3f2eba45d8fab85c02f1/apps/website/src/pages/docs/_layout.astro#L214C1-L216

I found the related padding in this file, maybe try meddling with this number? also make sure all other pages still look ok too

@mayank99
Copy link
Contributor

what problem is this PR actually trying to solve? because the previous spacing looks better to me.

@marashad001
Copy link
Contributor Author

what problem is this PR actually trying to solve? because the previous spacing looks better to me.

The spacing between the different sections of the documents are too close together, they need more visual separation

#941 (comment)

The new styling does seperate the sections, but it does need refining to keep the website looking clean and polished.

@mayank99
Copy link
Contributor

i believe that comment was already addressed in #1193

@marashad001
Copy link
Contributor Author

i believe that comment was already addressed in #1193

OK. I'll close the PR, it seems redundant to try to fix a resolved comment.

@mayank99
Copy link
Contributor

is there some spacing you personally think still needs to be improved? because maybe that PR didn't fully solve the problem.

@marashad001
Copy link
Contributor Author

marashad001 commented Jul 14, 2023

is there some spacing you personally think still needs to be improved? because maybe that PR didn't fully solve the problem.

The main thing I notice is the lack of space between the <h2> headers and the other blocks of content. Since they are their own section with their own <h3> headers within them, they should have a little bit more space in between sections.

For example:

Breadcrumbs
image

Surface
image

Getting Started - this is the most prominent one I've seen
image

apps/website/src/pages/_global.astro Outdated Show resolved Hide resolved
apps/website/src/pages/_global.astro Outdated Show resolved Hide resolved
Copy link
Contributor

@LostABike LostABike left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@marashad001 marashad001 enabled auto-merge July 20, 2023 18:22
@marashad001 marashad001 disabled auto-merge July 20, 2023 18:22
@marashad001 marashad001 added this pull request to the merge queue Jul 20, 2023
Merged via the queue into dev with commit f0379c0 Jul 20, 2023
@marashad001 marashad001 deleted the malik/docs-styling-spacing branch July 20, 2023 19:41
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.

3 participants