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

User guide layout #5016

Merged
merged 25 commits into from
Apr 22, 2024
Merged

User guide layout #5016

merged 25 commits into from
Apr 22, 2024

Conversation

ady-beraud
Copy link
Contributor

  • Modified CSS: font-size, colors, margins...

  • Added an ArticleContent Component that will be used for the changelog and user guide articles, which contains the styles for each titles, paragraphs, images etc.

  • Added link to User Guide in footer

  • Added a UserGuideWarning Component:

Screenshot 2024-04-17 at 18 14 48
  • Added a UserGuideEditContent Component:
Screenshot 2024-04-17 at 18 16 24
  • Added a UserGuideLink Component (for usage in MDX to allow links to open in new tab)

  • Fixed table of content

  • Made responsive

Copy link
Member

Choose a reason for hiding this comment

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

You increased the weight of images while reducing their size :)

Fyi I like to use this https://imageoptim.com/mac - maybe it can help

Copy link
Member

Choose a reason for hiding this comment

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

Thomas just told me they will change anyway, so let's keep them like this for now - don't waste time on this!

`;

const StyledHeaderInfoSectionSub = styled.div`
display: flex;
flex-direction: column;
gap: ${Theme.spacing(4)};
color: ${Theme.text.color.tertiary};
font-family: ${Theme.font.family};
line-height: 28.8px;
Copy link
Member

Choose a reason for hiding this comment

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

Feels a bit strange?

`;

const StyledImage = styled.img`
width: 300px;
border-bottom: 1.13px solid var(--Transparency-Strong, #14141429);
Copy link
Member

Choose a reason for hiding this comment

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

1.13px feels strange?what is var(--Transparency-Strong)? Can you introduce variables in the theme instead?

<p>
As an open-source company, we invite modifications to our GitHub user
guide for real-time updates, accuracy improvement, and broader
comprehensibility through community contributions.
Copy link
Member

Choose a reason for hiding this comment

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

Since you're english-native would you mind improving this text a bit to make it feel more natural? Feel free to always take the liberty to edit anything you see that feels ood! The more straightforward, the better, let's not overplay (e.g. "real time update", "comprehensibility", etc)

Copy link
Member

@FelixMalfait FelixMalfait left a comment

Choose a reason for hiding this comment

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

Great progress!

@FelixMalfait
Copy link
Member

FelixMalfait commented Apr 18, 2024

+ merge main to solve conflicts

@ady-beraud
Copy link
Contributor Author

Applied required modifications + modified different layout issues

return (
<StyledContainer>
<div>
<h1>Noticed something to modify ?</h1>
Copy link
Member

Choose a reason for hiding this comment

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

Great text!!! But not space before exclamation or interrogation mark in english

@FelixMalfait
Copy link
Member

It feels very strange not to have any behavior when hovering links on the left-side menu. It makes the user feel like they're not clickable. Was that part of the original design? Same for the image boxes on the user guide's index and the right side sidebar links

@ady-beraud
Copy link
Contributor Author

Added hover and removed space before exclamation/interrogation mark

@FelixMalfait
Copy link
Member

Great!

@FelixMalfait FelixMalfait merged commit b9a7eb5 into main Apr 22, 2024
5 checks passed
@FelixMalfait FelixMalfait deleted the user-guide-layout branch April 22, 2024 15:04
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.

None yet

5 participants