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

Use new documentation layout on Vanilla site #4863

Merged
merged 13 commits into from
Nov 23, 2023

Conversation

bartaz
Copy link
Member

@bartaz bartaz commented Aug 29, 2023

Done

Apply new documentation layout to Vanilla website.
This mostly affects docs section, but the whole site now uses paper background as well.

Fixes WD-6055

QA

  • Open demo
  • Review the docs, make sure layout is fine and components look good on new background

@webteam-app
Copy link

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

@bartaz bartaz changed the title Update Vanilla site to use full width layout only in docs POC: New documentation layout Sep 4, 2023
@bartaz bartaz force-pushed the vanilla-docs-layout branch 2 times, most recently from c84e0e0 to 0b4861c Compare October 5, 2023 14:12
@bartaz bartaz changed the title POC: New documentation layout Use new documentation layout on Vanilla site Nov 15, 2023
@bartaz bartaz added Review: Design needed Documentation 📝 Documentation changes or updates labels Nov 15, 2023
@bartaz bartaz marked this pull request as ready for review November 15, 2023 15:21
@lyubomir-popov
Copy link
Contributor

lyubomir-popov commented Nov 15, 2023

Looks great, and the accordion helps a lot I think. A few niggles I noticed:

  • clicking on any sidenav item leads to the scrollbar becoming visible for a fraction of a second

  • resizing from smaller width to bigger leaves the codepen examples at the earlier height, with a lot of white space underneath. Can we resize them onresize?
    image

  • the sidenav highlight goes under the scrollbar
    image

  • the footer should use the dark theme link colours:
    image

  • I know we have a separate issue for this, but just pointing out it is still protruding. We discussed making menu item padding same as grid gutter padding to solve this. Can it be a driveby here or something we merge before this pr?
    image

  • we should be using the paper colour to stay consistent with the new branding

@bartaz bartaz force-pushed the vanilla-docs-layout branch 2 times, most recently from ab9a3e4 to a23f43f Compare November 17, 2023 13:14
@bartaz
Copy link
Member Author

bartaz commented Nov 17, 2023

Looks great, and the accordion helps a lot I think. A few niggles I noticed:

  • clicking on any sidenav item leads to the scrollbar becoming visible for a fraction of a second

I can't reproduce it and don't really know what we could do about it. If it is a visible issue we can address it separately.

  • resizing from smaller width to bigger leaves the codepen examples at the earlier height, with a lot of white space underneath. Can we resize them onresize?

Done.

  • the sidenav highlight goes under the scrollbar

macOS shows scrollbar over the content, not much we can do about it.

  • the footer should use the dark theme link colours:

Done

  • I know we have a separate issue for this, but just pointing out it is still protruding. We discussed making menu item padding same as grid gutter padding to solve this. Can it be a driveby here or something we merge before this pr?

I made a quick hack for it (shifted the items to make them aligned). Adjusting padding is a separate issue and it turned out not to be quick (because of legacy of old navigation styles), so I'll address it separately later.

  • we should be using the paper colour to stay consistent with the new branding

Done

@bartaz bartaz merged commit b9274c8 into canonical:main Nov 23, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📝 Documentation changes or updates Guest dev 🤝 Good issue to work on with guest devs Review: Code +1 Review: Design +1 Review: QA +1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants