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

Add search box description to upgrade guide #4201

Merged

Conversation

bethcollins92
Copy link
Contributor

@bethcollins92 bethcollins92 commented Dec 13, 2021

Done

  • Add a new section to the navigation section in the upgrade guide, describing the use of the new expanding search box component. (Not sure if the link is correct?)
  • NOTE: I will change the order of everything when tackling this issue

Fixes #1175

QA

  • Open demo
  • Review updated documentation:
    • new search box paragraph added to navigation section

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.

@bethcollins92 bethcollins92 added the Documentation 馃摑 Documentation changes or updates label Dec 13, 2021
@webteam-app
Copy link

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

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

@bethcollins92 bethcollins92 merged commit 390dd6b into canonical:main Dec 13, 2021
@bethcollins92 bethcollins92 deleted the 1175-add-search-box-to-docs branch December 13, 2021 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 馃摑 Documentation changes or updates Review: QA +1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants