Skip to content

Commit

Permalink
chore(docs): september update (VIV-000) (#1900)
Browse files Browse the repository at this point in the history
* chore: updates sept docs

* chore: removes v4 announcement from docs

* chore: fixes typo

---------

Co-authored-by: James Taylor <[email protected]>
  • Loading branch information
TaylorJ76 and James Taylor authored Sep 12, 2024
1 parent 1c28e9e commit 300a4b9
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 33 deletions.
7 changes: 3 additions & 4 deletions apps/docs/assets/styles/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -232,9 +232,8 @@ p.lede {
max-inline-size: 55ch;
}

article.article > h1 + .heading-wrapper h2,
article.article > h1 + p + .heading-wrapper h2 {
margin-block-start: 0;
.heading-wrapper:first-of-type h2 {
margin-block-start: 36px;
}

vwc-tab-panel pre.hljs:first-child {
Expand Down Expand Up @@ -290,7 +289,6 @@ vwc-note ~ vwc-note {
.table-wrapper {
display: inline-flex;
box-sizing: border-box;
padding-block: 8px;
}

@media (width <= 768px) {
Expand All @@ -302,6 +300,7 @@ vwc-note ~ vwc-note {

table {
border-collapse: collapse;
margin-block: 16px;
}

thead > tr {
Expand Down
24 changes: 1 addition & 23 deletions apps/docs/content/_layouts/base.njk
Original file line number Diff line number Diff line change
Expand Up @@ -44,29 +44,7 @@
{% block header %}{% endblock %}
</head>

<body class="page-not-ready with-announcement-banner" hx-boost="true" hx-target="main" hx-select="main" hx-swap="outerHTML">
<vwc-banner class="announcement-banner" icon="sparkles-solid"
text="We are pleased to announce Vivid v4.0.0. Please check out the migration guide"
connotation="announcement"
>
<vwc-button
appearance="ghost"
slot="action-items"
class="vvd-theme-alternate desktop"
label="V4 Migration Guide"
icon="double-chevron-right-line" icon-trailing
href="/guides/v4-release-migration/"
></vwc-button>
<vwc-button
appearance="ghost"
slot="action-items"
class="vvd-theme-alternate mobile-only"
aria-label="V4 Migration Guide"
icon="open-line"
href="/guides/v4-release-migration/"
></vwc-button>
</vwc-banner>

<body class="page-not-ready" hx-boost="true" hx-target="main" hx-select="main" hx-swap="outerHTML">
<vwc-header id="header-main" slot="app-content">

<div class="header-content-wrapper">
Expand Down
2 changes: 0 additions & 2 deletions apps/docs/content/guides/eslint-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,4 @@ The plugin provides a set of rules that can be extended or overridden. To custom

### {{ rule.name }}

{% renderFile rule.markdown %}

{% endfor %}
6 changes: 2 additions & 4 deletions apps/docs/content/guides/vivid-2-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,8 @@ order: 6

# Migrating From Vivid 2.x to Vivid 3.x

Vivid 3.x has been rewritten from scratch.

It comes with almost all components that are available in Vivid 2.x, and many new ones.
All of them are better in both code and semantics. All the components are aligned with the HTML spec and are accessible.
Vivid 3.x has been rewritten from scratch.<br />It comes with almost all components that are available in Vivid 2.x, and many new ones.
All of them are better in both code and semantics. All the components are aligned with the HTML spec and are more accessible.

If you are migrating to Vivid 3.x, you can install it alongside Vivid 2.x for an easy and gradual migration.

Expand Down
32 changes: 32 additions & 0 deletions apps/docs/content/whats-new/monthly-updates/september-2024.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: September 2024
month: 2024-09
---

# September 2024 - Monthly Update

## Office Hours Meetings

See the [Office Hours minutes](https://docs.google.com/document/d/1E0yvyGUzBoQFH5l_W6ElBoZaxqZ3HWmDLDqOl0lc8a0/edit#heading=h.6an7tptc81o2) for more details.

**03/09/2024**

- A question was raised over the Vivid / Vue binding bundle size
- Libraries such as Video.js are being exported even when not used
- It was agreed to look into improving tree shaking in the Vue bindings

## Data-grid: sort icon placement change

The [sort icon in the header](/components/data-grid/#columndefinitions) of data-grid are now aligned closer to the header text.

## FAB: adds condensed size

We have added a [condensed size](/components/fab/#size) to the FAB component.

## Icon: adds warning connotation

We have added a [warning connotation](/components/icon/#connotation) to the Icon component.

## Tabs: adds shadow to tabs list when they scroll

We have added a shadow to the tab list container when the number/size of tab items creates a scroll. Previously, it could be hard to see that there were more items.

0 comments on commit 300a4b9

Please sign in to comment.