Linter testing new action location #181
Draft
+445
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…linter-testing-new-action-location
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ## Overview | ||
|
|
||
| BigCommerce for WordPress (BC4WP) is compatible out-of-the-box with all standard WordPress themes and includes full support for the Genesis theme framework. The plugin includes templates and stylesheets to render all of the elements and pages you need to merchandise your products and move shoppers through checkout, including: |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) | This sentence is 26 words long.
|
|
||
| ### Template overrides | ||
|
|
||
| When a WordPress plugin is updated, the new version overwrites existing plugin files. To ensure that your customizations persist through the update process, it’s important to use overrides in your theme files rather than editing plugin files directly. |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) | This sentence is 25 words long.
|
|
||
| When a WordPress plugin is updated, the new version overwrites existing plugin files. To ensure that your customizations persist through the update process, it’s important to use overrides in your theme files rather than editing plugin files directly. | ||
|
|
||
| To override any template, create a bigcommerce directory in your theme and copy the template file to that directory. |
There was a problem hiding this comment.
bigcommerce is misspelt
|
|
||
| Copy `templates/public/components/page-wrapper.php` to `bigcommerce/components/page-wrapper.php` | ||
|
|
||
| As WordPress loads, it will first check for a custom template override in your theme's `/bigcommerce` directory; if there is no custom template there, WordPress will fetch the built-in plugin template instead. |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) | This sentence is 32 words long.
|
|
||
| ### Required element classes | ||
|
|
||
| BC4WP relies on specially named element classes for JavaScript functionality, and we strongly recommend leaving the default class names untouched as you create custom templates. You are, however, welcome to create additional classes. |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) | This sentence is 25 words long.
|
|
||
| `$product = \BigCommerce\Post_Types\Product\Product::by_product_id( $product_id );` | ||
|
|
||
| In the context of many templates, the `$product` variable is already available to you. Check the docblock at the top of the template file to see defined variables in that scope. |
There was a problem hiding this comment.
docblock is misspelt
|
|
||
| The `bigcommerce/init` action fires after the plugin has completed initializing all of its service providers and hooked them into WordPress. It passes two arguments: the primary plugin controller (an instance of the BigCommerce\Plugin class) and the dependency injection container itself. The former is also available at any time after initialization by calling the function `bigcommerce()`. | ||
|
|
||
| An instance of each of the service providers found in the src/BigCommerce/Container directory can be accessed via this plugin controller, using the keys specified in `\BigCommerce\Plugin::load_service_providers()`. E.g., to get an instance of the BigCommerce\Container\Cart service provider, you would use `bigcommerce()->cart`. |
There was a problem hiding this comment.
src is misspelt; did you mean arc, sec, soc, orc, sac, sic, IRC, NRC, PRC, RC, Sc, Sr, SRO?
|
|
||
| ### Embedded checkout | ||
|
|
||
| Embedded Checkout includes settings within the WordPress theme customizer that allow you to adjust colors to blend the checkout page with your theme. For advanced users, the plugin provides the [Checkout Config hook](https://bigcommerce.moderntribe.qa/reference/hooks/bigcommerce-checkout-config/) to filter all available [Embedded Checkout config options](https://github.com/bigcommerce/checkout-sdk-js/blob/master/docs/interfaces/EmbeddedCheckoutOptions.md) (GitHub). Because of the method used to load the Embedded Checkout within the iframe, styling checkout must be accomplished by filtering the available `$checkout_config` options rather than targeting element classes or IDs with CSS. |
There was a problem hiding this comment.
Hard to read sentence (confidence: 4/7) | This sentence is 33 words long.
|
|
||
| ### Embedded checkout | ||
|
|
||
| Embedded Checkout includes settings within the WordPress theme customizer that allow you to adjust colors to blend the checkout page with your theme. For advanced users, the plugin provides the [Checkout Config hook](https://bigcommerce.moderntribe.qa/reference/hooks/bigcommerce-checkout-config/) to filter all available [Embedded Checkout config options](https://github.com/bigcommerce/checkout-sdk-js/blob/master/docs/interfaces/EmbeddedCheckoutOptions.md) (GitHub). Because of the method used to load the Embedded Checkout within the iframe, styling checkout must be accomplished by filtering the available `$checkout_config` options rather than targeting element classes or IDs with CSS. |
There was a problem hiding this comment.
iframe is misspelt; did you mean frame?
Base automatically changed from
SELFDEV-565-move-docs-linter-action-to-docs-repo
to
main
April 8, 2024 19:13
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[DEVDOCS-]
What changed?
Release notes draft
Anything else?
ping {names}