Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-blocks/docs/README.md

151 lines
9.8 KiB
Markdown
Raw Normal View History

Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
# WooCommerce Blocks Handbook <!-- omit in toc -->
## Table of Contents <!-- omit in toc -->
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
- [Contributors](#contributors)
- [Internal developers](#internal-developers)
- [Third-party developers](#third-party-developers)
- [Designers](#designers)
Fix list indentation for the Blocks Handbook
2022-06-21 13:43:23 +00:00
- [Developer Resources](#developer-resources)
- [Tools](#tools)
- [Articles](#articles)
- [Tutorials](#tutorials)
Re-organise docs and add WP update instructions (https://github.com/woocommerce/woocommerce-blocks/pull/1691) * Move coding guideline and release docs to subdirectories * Strip down contributing md to link to new docs * Create main readme file to act as TOC * Getting started and testing docs from contributing.md * WP update testing checklist and docs for woocommerce/woocommerce-blocks#1285 * Update docs/contributors/smoke-testing.md Co-Authored-By: Albert Juhé Lluveras <aljullu@gmail.com> * link to svn doc * Link to docs from readme * Resolve feedback * More consistent $ usage Co-authored-by: Albert Juhé Lluveras <aljullu@gmail.com>
2020-01-31 12:48:11 +00:00
The WooCommerce Blocks Handbook provides documentation for designers and developers on how to extend or contribute to blocks, and how internal developers should handle new releases.
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
## Contributors
> Want to contribute to the WooCommerce Blocks plugin? The following documents offer information that can help you get started.
- [Contributing](contributors/contributing/README.md)
- [Getting Started](contributors/contributing/getting-started.md)
- [Coding Guidelines](contributors/contributing/coding-guidelines.md)
- [Block Script Assets](contributors/contributing/block-assets.md)
- [CSS Build System](contributors/contributing/css-build-system.md)
- [JavaScript Build System](contributors/contributing/javascript-build-system.md)
- [JavaScript Testing](contributors/contributing/javascript-testing.md)
- [Storybook & Components](contributors/contributing/storybook-and-components.md)
## Internal developers
> Are you an internal developer? The following documents offer information about the different blocks, the Block Client APIs, the Store API, the templates and the testing process.
- [Blocks](internal-developers/blocks/README.md)
- [Stock Reservation during Checkout](internal-developers/blocks/stock-reservation.md)
- [Features Flags and Experimental interfaces](internal-developers/blocks/feature-flags-and-experimental-interfaces.md)
- [Block Data](../assets/js/data/README.md)
- [Collections Store](../assets/js/data/collections/README.md)
- [Query State Store](../assets/js/data/query-state/README.md)
- [Schema Store](../assets/js/data/schema/README.md)
- [Block Client APIs](internal-developers/block-client-apis/README.md)
- [Checkout API interface](internal-developers/block-client-apis/checkout/checkout-api.md)
- [Checkout Flow and Events](internal-developers/block-client-apis/checkout/checkout-flow-and-events.md)
- [Notices](internal-developers/block-client-apis/notices.md)
- [Editor Components](../assets/js/editor-components/README.md)
- [SearchListControl](../assets/js/editor-components/search-list-control/README.md)
- [Tag](../assets/js/editor-components/tag/README.md)
- [TextToolbarButton](../assets/js/editor-components/text-toolbar-button/README.md)
- [Icons](../assets/js/icons/README.md)
- [Legacy Build](../assets/js/legacy/README.md)
- [Store API (REST API)](../src/StoreApi/README.md)
- [Storybook](../storybook/README.md)
- [Templates](internal-developers/templates/README.md)
- [BlockTemplateController.php](internal-developers/templates/block-template-controller.md)
- [ClassicTemplate.php](internal-developers/templates/classic-template.md)
- [Classic Template Block](../assets/js/blocks/classic-template/README.md)
- [Testing](internal-developers/testing/README.md)
- [When to employ end to end testing](internal-developers/testing/when-to-employ-e2e-testing.md)
- [Smoke Testing](internal-developers/testing/smoke-testing.md)
- [Cart and Checkout Testing](internal-developers/testing/cart-checkout/README.md)
- [General Flow](internal-developers/testing/cart-checkout/general-flow.md)
- [Editor](internal-developers/testing/cart-checkout/editor.md)
- [Shipping](internal-developers/testing/cart-checkout/shipping.md)
- [Payments](internal-developers/testing/cart-checkout/payment.md)
- [Items](internal-developers/testing/cart-checkout/items.md)
- [Taxes](internal-developers/testing/cart-checkout/taxes.md)
- [Coupons](internal-developers/testing/cart-checkout/coupons.md)
- [Compatibility](internal-developers/testing/cart-checkout/compatibility.md)
- [Releases](internal-developers/testing/releases/README.md)
Clean up docs (https://github.com/woocommerce/woocommerce-blocks/pull/6550) * Link translation section to docs file * Delete duplicated docs * Move internal developer docs into corresponding folder * Correct merge conflict * Change ‘docs/testing/’ to ‘docs/internal-developers/testing’ * Fix visible \ and missing bulletpoint * Add missing testing notes
2022-06-20 17:04:41 +00:00
- [Translations](internal-developers/translations/README.md)
- [Translation basics](internal-developers/translations/translation-basics.md)
- [Translations in PHP files](internal-developers/translations/translations-in-PHP-files.md)
- [Translations in JS/TS files](internal-developers/translations/translations-in-JS-TS-files.md)
- [Translations in FSE templates](internal-developers/translations/translations-in-FSE-templates.md)
- [Translations for lazy-loaded components](internal-developers/translations/translations-for-lazy-loaded-components.md)
- [Translation loading](internal-developers/translations/translation-loading.md)
- [Translation management](internal-developers/translations/translation-management.md)
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
## Third-party developers
> Are you a third-party developer? The following documents explain how to extend the WooCommerce Blocks plugin with your custom extension.
- [Extensibility](third-party-developers/extensibility/README.md)
- Hooks
- [Actions](third-party-developers/extensibility/hooks/actions.md)
- [Filters](third-party-developers/extensibility/hooks/filters.md)
- REST API
- [Exposing your data in the Store API](third-party-developers/extensibility/rest-api/extend-rest-api-add-data.md)
- [Available endpoints to extend with ExtendSchema](third-party-developers/extensibility/rest-api/available-endpoints-to-extend.md)
- [Adding an endpoint to ExtendSchema](third-party-developers/extensibility/rest-api/extend-rest-api-new-endpoint.md)
- [Available Formatters](third-party-developers/extensibility/rest-api/extend-rest-api-formatters.md)
- [Updating the cart with the Store API](third-party-developers/extensibility/rest-api/extend-rest-api-update-cart.md)
- Checkout Payment Methods
- [Checkout Flow and Events](third-party-developers/extensibility/checkout-payment-methods/checkout-flow-and-events.md)
- [Payment Method Integration](third-party-developers/extensibility/checkout-payment-methods/payment-method-integration.md)
- [Filtering Payment Methods](third-party-developers/extensibility/checkout-payment-methods/filtering-payment-methods.md)
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
- Checkout Blocks
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
- [IntegrationInterface](third-party-developers/extensibility/checkout-block/integration-interface.md)
- [Available Filters](third-party-developers/extensibility/checkout-block/available-filters.md)
- [Slots and Fills](third-party-developers/extensibility/checkout-block/slot-fills.md)
- [Available Slot Fills](third-party-developers/extensibility/checkout-block/available-slot-fills.md)
- [DOM Events](third-party-developers/extensibility/checkout-block/dom-events.md)
- [Blocks Registry](../packages/checkout/blocks-registry/README.md)
- [Components](../packages/checkout/components/README.md)
- [Filter Registry](../packages/checkout/filter-registry/README.md)
- [Slot and Fill](../packages/checkout/slot/README.md)
- [Utilities](../packages/checkout/utils/README.md)
## Designers
> Are you a designer? The following documents explain how to apply design-changes to the WooCommerce Blocks plugin.
- [Theming](designers/theming/README.md)
- [All Products & filters](designers/theming/all-products-and-filters.md)
- [Cart and Checkout](designers/theming/cart-and-checkout.md)
- [Class names update in 4.6.0](designers/theming/class-names-update-460.md)
- [Class names update in 3.4.0](designers/theming/class-names-update-340.md)
- [Class names update in 3.3.0](designers/theming/class-names-update-330.md)
- [Class names update in 2.8.0](designers/theming/class-names-update-280.md)
- [Product grid blocks style update in 2.7.0](designers/theming/product-grid-270.md)
## Developer Resources
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
### Tools
- [@woocommerce/extend-cart-checkout-block](https://www.npmjs.com/package/@woocommerce/extend-cart-checkout-block) This is a template to be used with @wordpress/create-block to create a WooCommerce Blocks extension starting point.
- [How to integrate with inner blocks in the WooCommerce Blocks Checkout](https://github.com/woocommerce/newsletter-test) A repository with some example code showing how an extension can register an inner block for use in the Checkout Block.
### Articles
The following posts from [developer.woocommerce.com](https://developer.woocommerce.com/category/developer-resources/) provide deeper insights into the WooCommerce Blocks development.
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
- [Store API is now considered stable](https://developer.woocommerce.com/2022/03/25/store-api-is-now-considered-stable/)
- [Available Extensibility Interfaces for The Cart and Checkout Blocks](https://developer.woocommerce.com/2021/11/09/available-extensibility-interfaces-for-the-cart-and-checkout-blocks/)
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
### Tutorials
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
Update the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6601) * Update the WooCommerce Blocks Handbook Add 3 subsections to the Developer resources section and add the new tools we have availble * Grammar fixes
2022-06-21 13:41:30 +00:00
The following tutorials from [developer.woocommerce.com](https://developer.woocommerce.com/category/tutorials/) help you with extending the WooCommerce Blocks plugin.
Improve the structure of the WooCommerce Blocks Handbook (https://github.com/woocommerce/woocommerce-blocks/pull/6429) * Improve the structure of the WooCommerce Blocks Handbook Co-authored-by: Rania Lang <rania.langouretou@automattic.com>
2022-06-09 15:52:19 +00:00
- [Hiding Shipping and Payment Options in the Cart and Checkout Blocks](https://developer.woocommerce.com/2022/05/20/hiding-shipping-and-payment-options-in-the-cart-and-checkout-blocks/)
- [Integrating your Payment Method with Cart and Checkout Blocks](https://developer.woocommerce.com/2021/03/15/integrating-your-payment-method-with-cart-and-checkout-blocks/)
Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) * Add links to single routes in main index woocommerce/woocommerce-blocks#4473 * Footer * Feedback template * Remove footer from existing MD files * Add doc footer script * Apply script to all docs * Fix examples
2022-02-02 14:27:46 +00:00
<!-- FEEDBACK -->
Format Markdown files using wp-scripts (https://github.com/woocommerce/woocommerce-blocks/pull/6462) * Format Markdown files using Prettier * Format Markdown files using wp-scripts * Adjust MD linting
2022-06-09 12:43:17 +00:00
Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) * Add links to single routes in main index woocommerce/woocommerce-blocks#4473 * Footer * Feedback template * Remove footer from existing MD files * Add doc footer script * Apply script to all docs * Fix examples
2022-02-02 14:27:46 +00:00
---
[We're hiring!](https://woocommerce.com/careers/) Come work with us!
Add docs about translation handling (https://github.com/woocommerce/woocommerce-blocks/pull/6405) * Create translation handling files * Add docs about “Translation basics” * Update docs for “Translation basics” * Add docs about “Translations in PHP files” * Add docs about “Translations in JS/TS files” * Update docs for “Translation basics” * Add docs for “Translation management” * Add docs for “Translations in FSE templates” * Add “Translations” to “WooCommerce Blocks Handbook” * Add docs for “Lazy-load translations” * Rewrite first paragraph of “Translations in FSE templates” * Fix typo * Update repo URL * Remove obsolete space and comma * Update repo URL * Rename lazy-load file * Add section about “sprintf()” to “Translations in JS/TS files” * Remove reference to “npm install @wordpress/i18n” * Add docs for “Translation files and loading” * Rename readme.md to README.md * Remove double file extension * Remove self-explaining explenations * Update docs/README.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translation-basics.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translation-basics.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translation-loading.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translation-loading.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translation-loading.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translation-loading.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translation-loading.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translation-loading.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translation-management.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Update docs/translations/translations-in-FSE-templates.md Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com> * Clarify how to use variables in translations * Change “i18n” to “internationalization (i18n)” * Link translation functions to the WordPress reference * Add Translation management to Translation management * Update “Translations in FSE templates” * Lint Markdown files * Update chunk translation register functions * Update function that loads the translation file * Update information about lazy-loading * Adjust lazy-loading docs title and file name Co-authored-by: Thomas Roberts <5656702+opr@users.noreply.github.com>
2022-06-10 15:40:05 +00:00
🐞 Found a mistake, or have a suggestion? [Leave feedback about this document here.](https://github.com/woocommerce/woocommerce-blocks/issues/new?assignees=&labels=type%3A+documentation&template=--doc-feedback.md&title=Feedback%20on%20./docs/readme.md)
Format Markdown files using wp-scripts (https://github.com/woocommerce/woocommerce-blocks/pull/6462) * Format Markdown files using Prettier * Format Markdown files using wp-scripts * Adjust MD linting
2022-06-09 12:43:17 +00:00
Include issue submission link in the footer of all documention (.md files) (https://github.com/woocommerce/woocommerce-blocks/pull/5655) * Add links to single routes in main index woocommerce/woocommerce-blocks#4473 * Footer * Feedback template * Remove footer from existing MD files * Add doc footer script * Apply script to all docs * Fix examples
2022-02-02 14:27:46 +00:00
<!-- /FEEDBACK -->