canonical / canonical/vanilla-framework

[Component amendment]: Merge or Deprecate Logo Section component in favor of Logo Section Pattern

Open
#5,635 14 comments 1 reaction 0 assignees View on GitHub
Priority: Low Tier: Sites WG: Validated
Dominant language
HTML
Stars
983
Forks
216
Avg merge
3d 13h
Merged PRs (30d)
3

Description

## Component/pattern to amend

Logo Section

## Context

In #5632 @muhammad-ali-pk is implementing the "Logo section pattern", per this [design](https://www.figma.com/design/1brHCsyeTE6FU7hfJd6ao2/%F0%9F%9A%A7---WIP--Sites---Core-component-library?node-id=336-20426&m=dev) from @kim-isaac .

This naming clashes with the existing "logo section" component. @kim-isaac believes that the logo section pattern will be the new "standard" way to use logo sections across our projects, and as such the logo section component in #5632 was informally slated to be deprecated in that PR - however we would like to confirm what the best approach is in this issue.

We see a few alternatives:
1. Merge the logo section component with the logo section pattern, and delete the docs page for the component. The logo section pattern requires the CSS of the logo section component, much like the [pricing block](https://vanillaframework.io/docs/patterns/pricing-block), which presents a model of what a merged logo section page might look like. We could then document separately (on the same page) how to create logo sections with the pattern and underlying component.
2. Deprecate the logo section component in favor of only documenting the logo section pattern.
3. Keep the logo section component as-is, and introduce the logo section pattern, accepting them having the same name

In any case, patternless logo sections could still be built with either the [logo section content block](https://vanillaframework.io/docs/patterns/basic-section#logo-section) or raw markup (logo section still requires its own CSS), so this shouldn't be a breaking change - it's more a question of naming and documentation.

Contributor guide

Open the contributing guide

Research direction

Review issue #5632 and the linked Figma design first, then compare the existing Logo Section component with the proposed Logo Section Pattern and the pricing block documentation model. Done means reaching a decision on merge, deprecation, or coexistence and documenting the chosen approach without leaving the naming conflict unresolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, html
Domain
documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.