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

Demo of design sprint brochure site documentation #4708

Merged
merged 14 commits into from
Mar 30, 2023
Merged

Conversation

bartaz
Copy link
Contributor

@bartaz bartaz commented Mar 21, 2023

Added a (work in progress) documentation on how to build brochure sites:
https://vanilla-framework-4708.demos.haus/docs/layouts/brochure

This is based on Figma design: https://www.figma.com/file/DZ7V6EFl18u72JLJrFDB2v/Building-brochure-pages-with-Vanilla-4.0

Currently it just includes the main examples of layouts as first pass, more content will be added later.

QA

@webteam-app
Copy link

Demo starting at https://vanilla-framework-4708.demos.haus

@bartaz bartaz added the Documentation 📝 Documentation changes or updates label Mar 29, 2023
@ClementChaumel
Copy link
Contributor

It makes sense to use the layout we're talking about to showcase it but since it's embedded in the full-width one it's kind of a weird case IMO
I know I should read it as the green lines show but in my mind, I keep including the navigation like the red lines show

image

What do you think?

@bartaz
Copy link
Contributor Author

bartaz commented Mar 30, 2023

It makes sense to use the layout we're talking about to showcase it but since it's embedded in the full-width one it's kind of a weird case IMO

Yes, I know what you mean. The thing is that the side navigation is outside of the grid, so it's not really counted in that. But I know that it may not look like this (especially on smaller screens when you see it close.

In the end, this is how it's gonna look like. Maybe we can later explain better that in layout with side navigation navigation is not part of this 25% rule. But for now it is how it is expected to be.

@ClementChaumel
Copy link
Contributor

In the end, this is how it's gonna look like. Maybe we can later explain better that in layout with side navigation navigation is not part of this 25% rule. But for now it is how it is expected to be.

Ah ok I wasn't sure if it was meant to be used alongside the navigation. All good then!

Copy link
Contributor

@ClementChaumel ClementChaumel left a comment

Choose a reason for hiding this comment

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

This looks good to me. I just had a higher-order question: Since this is how we want the pages to be built shouldn't this be treated as a new pattern with its own classes instead of just being built with col?

templates/docs/layouts/brochure.md Outdated Show resolved Hide resolved
<p class="u-no-margin--bottom">
A page is a sequence of sections sandwiched between a header and a footer. To create a successful page, we need to get 3 things right:
<p>
<ul class="p-list--divided" style="max-width: 40rem">{# TODO: replace with max-width utility when implemented #}
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we want to add a max-width utility or just update the lists to match the <p> behaviour?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good question that I didn't want to solve in this PR. I'll open a separate issue and we can discuss there.

Co-authored-by: ClementChaumel <clement.chaumel@gmail.com>
@bartaz
Copy link
Contributor Author

bartaz commented Mar 30, 2023

This looks good to me. I just had a higher-order question: Since this is how we want the pages to be built shouldn't this be treated as a new pattern with its own classes instead of just being built with col?

Yes, that's what https://warthogs.atlassian.net/browse/WD-2886 is about, but for now we want to provide documentation about how to build it with current Vanilla, so devs don't have to wait for new components.

@bartaz bartaz merged commit 89dfc42 into main Mar 30, 2023
@bartaz bartaz deleted the design-components-sprint branch March 30, 2023 12:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants