Skip to content

@W-17618443 Extensibility tutorial documentation#2256

Merged
kevinxh merged 3 commits intofeature/extensibility-v2from
W-17618443-extensibility-tutorial
Feb 13, 2025
Merged

@W-17618443 Extensibility tutorial documentation#2256
kevinxh merged 3 commits intofeature/extensibility-v2from
W-17618443-extensibility-tutorial

Conversation

@kevinxh
Copy link
Contributor

@kevinxh kevinxh commented Feb 12, 2025

Description

This PR adds a tutorial.md file for extensibility feature.

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • Breaking change (could cause existing functionality to not work as expected)
  • Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

  • Removing a public function or component or prop
  • Adding a required argument to a function
  • Changing the data type of a function parameter or return value
  • Adding a new peer dependency to package.json

Changes

  • (change1)

How to Test-Drive This PR

  • (step1)

Checklists

General

  • Changes are covered by test cases
  • CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

  • There are no changes to UI

or...

Localization

  • Changes include a UI text update in the Retail React App (which requires translation)

@kevinxh kevinxh requested a review from a team as a code owner February 12, 2025 20:24
First, we’ll generate a fresh PWA Kit project by running the following command:

```sh
npx @salesforce/pwa-kit-create-app@4.0.0-extensibility-preview.3
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: Should we use a NPM tag instead like extensibility-preview-latest and point that tag to the latest extensibility preview instead of using 4.0.0-extensibility-preview.3?

We probably will do at least one more release fixing bugs before beta so the version will most likely 4.0.0-extensibility-preview.4

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call, let's create the tag first and then we can update the docs.

First, open your terminal and run our project generator:

```
npx pwa-kit-create-app
Copy link
Contributor

Choose a reason for hiding this comment

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

@kevinxh kevinxh merged commit 09239dc into feature/extensibility-v2 Feb 13, 2025
4 checks passed
@kevinxh kevinxh deleted the W-17618443-extensibility-tutorial branch February 13, 2025 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants