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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

New vanilla website #4430

Merged
merged 25 commits into from
Apr 27, 2022
Merged

New vanilla website #4430

merged 25 commits into from
Apr 27, 2022

Conversation

albertkol
Copy link
Contributor

@albertkol albertkol commented Apr 20, 2022

Done

  • Remove old "Design" section from docs
  • Extract Accessibility docs into their own file
  • Rename Tab buttons to segmented control
  • Add tab menu on the docs pages for accessibility and design guidelines.
  • Docs tab menu settings are set on component_tabs.yaml file.

QA

  • Code has already been reviewed for each PR separately - this PR is the final QA
  • Go to /docs check the tab menus for each pattern and layout

Check if PR is ready for release

If this PR contains Vanilla SCSS code changes, it should contain the following changes to make sure it's ready for the release:

  • PR should have one of the following labels to automatically categorise it in release notes:
    • Feature 馃巵, Breaking Change 馃挘, Bug 馃悰, Documentation 馃摑, Maintenance 馃敤.
  • Vanilla version in package.json should be updated relative to the most recent release, following semver convention:
    • if CSS class names are not changed it can be bugfix relesase (x.x.X)
    • if CSS class names are changed/added/removed it should be minor version (x.X.0)
    • see the wiki for more details
  • Any changes to component class names (new patterns, variants, removed or added features) should be listed on the what's new page.
  • Documentation side navigation should be updated with the relevant labels.

Screenshots

image

@webteam-app
Copy link

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

@bethcollins92
Copy link
Contributor

Noticed in QA - on the design guidelines page, the subtitles don't appear in the side nav

albertkol and others added 3 commits April 21, 2022 13:11
* add generate id from header

* lint

* replace special chars
templates/_layouts/docs_discourse.html Outdated Show resolved Hide resolved
@bethcollins92
Copy link
Contributor

bethcollins92 commented Apr 25, 2022

Hi @lyubomir-popov - I added the p-strip to the titles. The spacing looked quite big so I also added the is-shallow class. Let me know what you think - I can always remove it. Thanks!

https://vanilla-framework-4430.demos.haus/docs/patterns/accordion

Shallow:

Screenshot 2022-04-26 at 08 44 03

Regular:

Screenshot 2022-04-26 at 08 43 26

@bethcollins92 bethcollins92 added the Feature 馃巵 New feature or request label Apr 25, 2022
@lyubomir-popov
Copy link
Contributor

Hi @bethcollins92, my proposal here was to decrease the space above, increase the space between the heading, to create a more deliberate look:

image

@bethcollins92
Copy link
Contributor

Thanks @lyubomir-popov - made those changes

@lyubomir-popov
Copy link
Contributor

lyubomir-popov commented Apr 26, 2022

Thanks @bethcollins92, looks good.

@bethcollins92
Copy link
Contributor

Woop. @bartaz this is ready for final QA check now

Copy link
Contributor

@bartaz bartaz left a comment

Choose a reason for hiding this comment

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

There are some pages with missing title:
https://vanilla-framework-4430.demos.haus/docs/patterns/contextual-menu
https://vanilla-framework-4430.demos.haus/docs/patterns/icons

image

maybe others as well.

We need to find out why and fix it.

component_tabs.yaml Outdated Show resolved Hide resolved
component_tabs.yaml Outdated Show resolved Hide resolved
@bartaz
Copy link
Contributor

bartaz commented Apr 27, 2022

Segmented control page has missing <hr> under the title

image

@bartaz
Copy link
Contributor

bartaz commented Apr 27, 2022

It feels weird to have more spacing on pages with tabs and no spacing on old docs without tabs. I think we should add the space to old templates as well. I guess it may end up a bigger change, not sure if we need to put it in this PR if it's too large.

docs-title-strip

Edit: on a second look, it doesn't look terribly broken, so I guess we don't need to block this PR on that. But would be nice to fix that later.

@cristinadresch cristinadresch assigned bartaz and bethcollins92 and unassigned bartaz Apr 27, 2022
@bethcollins92
Copy link
Contributor

I've fixed:

  • Pages with missing titles
  • <hr> added under segmentel control
  • An issue is created here about the spacing under headings issue

Copy link
Contributor

@bartaz bartaz left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@bethcollins92 bethcollins92 merged commit 7c72787 into main Apr 27, 2022
@bethcollins92 bethcollins92 deleted the new-vanilla-website branch April 27, 2022 13:41
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

6 participants