From 52dcaf91d7924cbcd227f8bb5b5ea85424620c9f Mon Sep 17 00:00:00 2001 From: Ron Rennick Date: Wed, 29 Nov 2023 14:48:05 -0400 Subject: [PATCH] add graymatter to docs --- docs/README.md | 4 ++- docs/code-snippets/README.md | 4 ++- docs/code-snippets/add-a-country.md | 4 ++- docs/code-snippets/add-a-currency-symbol.md | 4 ++- docs/code-snippets/add-or-modify-states.md | 4 ++- .../adjust-quantity-input-values.md | 4 ++- .../before-login--register-form.md | 4 ++- .../code-snippets/change-a-currency-symbol.md | 4 ++- .../customising-checkout-fields.md | 4 ++- .../number-of-products-per-row.md | 4 ++- docs/code-snippets/rename-a-country.md | 4 ++- .../unhook--remove-woocommerce-emails.md | 4 ++- docs/code-snippets/useful-functions.md | 4 ++- ...oding-guidelines-and-naming-conventions.md | 4 ++- docs/contributing/api-critical-flows.md | 4 ++- docs/contributing/common-issues.md | 4 ++- docs/contributing/deciding-pr-high-impact.md | 4 ++- docs/contributing/deprecation-in-core.md | 4 ++- .../minification-of-SCSS-and-JS.md | 4 ++- docs/contributing/naming-conventions.md | 4 ++- .../string-localisation-guidelines.md | 4 ++- docs/contributing/woocommerce-git-flow.md | 4 ++- docs/data-management/crud-objects.md | 4 ++- docs/data-management/data-stores.md | 4 ++- .../adding-a-section-to-a-settings-tab.md | 4 ++- .../building-your-first-extension.md | 4 ++- docs/extension-development/class-reference.md | 4 ++- .../development-environment.md | 4 ++- .../extension-developer-handbook.md | 4 ++- docs/extension-development/gdpr-compliance.md | 4 ++- ...andling-deactivation-and-uninstallation.md | 4 ++- .../handling-merchant-onboarding.md | 4 ++- ...-to-add-your-own-store-management-links.md | 4 ++- .../how-to-design-a-simple-extension.md | 4 ++- .../implementing-settings.md | 4 ++- docs/extension-development/readme.md | 6 +++- docs/extension-development/settings-api.md | 4 ++- .../tools-for-low-code-development.md | 4 ++- .../using-custom-attributes-in-menus.md | 12 +++++-- .../woocommerce-plugin-api-callback.md | 4 ++- docs/getting-started/debugging.md | 4 ++- docs/getting-started/developer-resources.md | 4 ++- docs/getting-started/developer-tools.md | 4 ++- docs/getting-started/readme.md | 6 +++- docs/getting-started/set-up-a-child-theme.md | 4 ++- docs/getting-started/woocommerce-endpoints.md | 4 ++- docs/high-performance-order-storage/README.md | 4 ++- .../enable-hpos.md | 4 ++- .../translating-woocommerce.md | 4 ++- docs/payments/payment-gateway-api.md | 4 ++- docs/payments/payment-gateway-plugin-base.md | 4 ++- docs/payments/payment-token-api.md | 4 ++- docs/product-editor-development/README.md | 4 ++- .../block-template-lifecycle.md | 4 ++- ...product-editor-extensibility-guidelines.md | 4 ++- .../coding-standards.md | 4 ++- .../core-critical-flows.md | 4 ++- .../css-sass-naming-conventions.md | 4 ++- .../grammar-punctuation-capitalization.md | 4 ++- .../naming-conventions.md | 4 ++- .../performance-optimization.md | 4 ++- docs/quality-and-best-practices/readme.md | 6 +++- ...t-product-category-or-shop-from-the-url.md | 4 ++- ...iting-high-quality-testing-instructions.md | 4 ++- ...-to-analytics-reports-and-csv-downloads.md | 4 ++- .../extending-woocommerce-admin-reports.md | 4 ++- docs/reporting/readme.md | 6 +++- docs/rest-api/getting-started.md | 4 ++- docs/rest-api/readme.md | 6 +++- docs/security/readme.md | 6 +++- docs/security/reporting-security-issues.md | 4 ++- docs/security/security-best-practices.md | 4 ++- docs/shipping/shipping-method-api.md | 4 ++- docs/style-guide.md | 6 +++- docs/theme-development/README.md | 4 ++- .../classic-theme-developer-handbook.md | 4 ++- docs/theme-development/conditional-tags.md | 4 ++- .../fixing-outdated-woocommerce-templates.md | 4 ++- .../theme-design-ux-guidelines.md | 4 ++- ...ing-a-custom-field-to-variable-products.md | 4 ++- docs/tutorials/adding-actions-and-filters.md | 4 ++- docs/tutorials/readme.md | 6 +++- docs/user-experience/accessibility.md | 4 ++- docs/user-experience/best-practices.md | 4 ++- docs/user-experience/colors.md | 4 ++- docs/user-experience/notices.md | 4 ++- docs/user-experience/onboarding.md | 4 ++- docs/user-experience/task-list-and-inbox.md | 4 ++- .../user-experience-guidelines.md | 4 ++- docs/utilities/configuring-caching-plugins.md | 32 +++++++++++++++---- docs/utilities/logging.md | 4 ++- docs/wc-cli/commands.md | 4 ++- docs/wc-cli/overview.md | 4 ++- 93 files changed, 323 insertions(+), 101 deletions(-) diff --git a/docs/README.md b/docs/README.md index cade84e0a17..c88482616bf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,6 @@ -# WooCommerce developer documentation +--- +post_title: WooCommerce developer documentation +--- > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/code-snippets/README.md b/docs/code-snippets/README.md index 4f74e28fcc0..60db52959e3 100644 --- a/docs/code-snippets/README.md +++ b/docs/code-snippets/README.md @@ -1,4 +1,6 @@ -# WooCommerce code snippets +--- +post_title: WooCommerce code snippets +--- Various code snippets you can add to your site to enable custom functionality: diff --git a/docs/code-snippets/add-a-country.md b/docs/code-snippets/add-a-country.md index fc3e2135a9d..b3f7ce76481 100644 --- a/docs/code-snippets/add-a-country.md +++ b/docs/code-snippets/add-a-country.md @@ -1,4 +1,6 @@ -# Add a country +--- +post_title: Add a country +--- Add this code to your child theme’s `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent theme’s functions.php file, as this will be wiped entirely when you update the theme. diff --git a/docs/code-snippets/add-a-currency-symbol.md b/docs/code-snippets/add-a-currency-symbol.md index a1655403920..ba99a85bc29 100644 --- a/docs/code-snippets/add-a-currency-symbol.md +++ b/docs/code-snippets/add-a-currency-symbol.md @@ -1,4 +1,6 @@ -# Add a currency and symbol +--- +post_title: Add a currency and symbol +--- Add this code to your child theme’s `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent theme’s functions.php file, as this will be wiped entirely when you update the theme. diff --git a/docs/code-snippets/add-or-modify-states.md b/docs/code-snippets/add-or-modify-states.md index 990887d84b9..0a7413eb605 100644 --- a/docs/code-snippets/add-or-modify-states.md +++ b/docs/code-snippets/add-or-modify-states.md @@ -1,4 +1,6 @@ -# Add or modify states +--- +post_title: Add or modify states +--- Add this code to your child theme’s `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent theme’s functions.php file, as this will be wiped entirely when you update the theme. diff --git a/docs/code-snippets/adjust-quantity-input-values.md b/docs/code-snippets/adjust-quantity-input-values.md index 4a3ed25cef9..6d548360e19 100644 --- a/docs/code-snippets/adjust-quantity-input-values.md +++ b/docs/code-snippets/adjust-quantity-input-values.md @@ -1,4 +1,6 @@ -# Adjust the quantity input values +--- +post_title: Adjust the quantity input values +--- Set the starting value, maximum value, minimum value, and increment amount for quantity input fields on product pages. diff --git a/docs/code-snippets/before-login--register-form.md b/docs/code-snippets/before-login--register-form.md index 12ef4621120..c2aef21f144 100644 --- a/docs/code-snippets/before-login--register-form.md +++ b/docs/code-snippets/before-login--register-form.md @@ -1,4 +1,6 @@ -# Add a message above the login / register form +--- +post_title: Add a message above the login / register form +--- This code will add a custom message above the login/register form on the user’s my-account page. diff --git a/docs/code-snippets/change-a-currency-symbol.md b/docs/code-snippets/change-a-currency-symbol.md index 9bdd9138f08..eacdd583457 100644 --- a/docs/code-snippets/change-a-currency-symbol.md +++ b/docs/code-snippets/change-a-currency-symbol.md @@ -1,4 +1,6 @@ -# Change a currency symbol +--- +post_title: Change a currency symbol +--- See the [currency list](https://woocommerce.github.io/code-reference/files/woocommerce-includes-wc-core-functions.html#source-view.475) for reference on currency codes. diff --git a/docs/code-snippets/customising-checkout-fields.md b/docs/code-snippets/customising-checkout-fields.md index 49c58179d5a..f23ee720123 100644 --- a/docs/code-snippets/customising-checkout-fields.md +++ b/docs/code-snippets/customising-checkout-fields.md @@ -1,4 +1,6 @@ -# Customizing checkout fields using actions and filters +--- +post_title: Customizing checkout fields using actions and filters +--- If you are unfamiliar with code and resolving potential conflicts, we have an extension that can help: [WooCommerce Checkout Field Editor](https://woo.com/products/woocommerce-checkout-field-editor/). Installing and activating this extension overrides any code below that you try to implement; and you cannot have custom checkout field code in your functions.php file when the extension is activated. diff --git a/docs/code-snippets/number-of-products-per-row.md b/docs/code-snippets/number-of-products-per-row.md index 12047d04388..f0973d2b727 100644 --- a/docs/code-snippets/number-of-products-per-row.md +++ b/docs/code-snippets/number-of-products-per-row.md @@ -1,4 +1,6 @@ -# Change number of related products output +--- +post_title: Change number of related products output +--- Add code to your child theme’s functions.php file or via a plugin that allows custom functions to be added, such as the [Code snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent theme’s `functions.php` file as this will be wiped entirely when you update the theme. diff --git a/docs/code-snippets/rename-a-country.md b/docs/code-snippets/rename-a-country.md index 1052350e817..3a9e87aaab6 100644 --- a/docs/code-snippets/rename-a-country.md +++ b/docs/code-snippets/rename-a-country.md @@ -1,4 +1,6 @@ -# Rename a country +--- +post_title: Rename a country +--- Add this code to your child theme’s `functions.php` file or via a plugin that allows custom functions to be added, such as the [Code Snippets](https://wordpress.org/plugins/code-snippets/) plugin. Avoid adding custom code directly to your parent theme’s functions.php file, as this will be wiped entirely when you update the theme. diff --git a/docs/code-snippets/unhook--remove-woocommerce-emails.md b/docs/code-snippets/unhook--remove-woocommerce-emails.md index 2afb4798a2d..a4d0c6788cd 100644 --- a/docs/code-snippets/unhook--remove-woocommerce-emails.md +++ b/docs/code-snippets/unhook--remove-woocommerce-emails.md @@ -1,4 +1,6 @@ -# Unhook and remove WooCommerce emails +--- +post_title: Unhook and remove WooCommerce emails +--- This code allows you to unhook and remove the default WooCommerce emails. diff --git a/docs/code-snippets/useful-functions.md b/docs/code-snippets/useful-functions.md index 8d553d3fee7..8b3c3857179 100644 --- a/docs/code-snippets/useful-functions.md +++ b/docs/code-snippets/useful-functions.md @@ -1,4 +1,6 @@ -# Useful core functions +--- +post_title: Useful core functions +--- WooCommerce core functions are available on both front-end and admin. They can be found in `includes/wc-core-functions.php` and can be used by themes in plugins. diff --git a/docs/contributing/CSS-SASS-coding-guidelines-and-naming-conventions.md b/docs/contributing/CSS-SASS-coding-guidelines-and-naming-conventions.md index 1bc53143edd..3052ee6082e 100644 --- a/docs/contributing/CSS-SASS-coding-guidelines-and-naming-conventions.md +++ b/docs/contributing/CSS-SASS-coding-guidelines-and-naming-conventions.md @@ -1,4 +1,6 @@ -# CSS SASS coding guidelines and naming conventions +--- +post_title: CSS SASS coding guidelines and naming conventions +--- Our guidelines are based on those used in [Calypso](https://github.com/Automattic/wp-calypso) which itself follows the BEM methodology. Refer to [this doc](https://wpcalypso.wordpress.com/devdocs/docs/coding-guidelines/css.md?term=css) for full details. There are a few differences in WooCommerce however which are outlined below; diff --git a/docs/contributing/api-critical-flows.md b/docs/contributing/api-critical-flows.md index cdd12afffc5..949b6fd9649 100644 --- a/docs/contributing/api-critical-flows.md +++ b/docs/contributing/api-critical-flows.md @@ -1,4 +1,6 @@ -# API critical flows +--- +post_title: API critical flows +--- In our documentation, we've pinpointed the essential user flows within the WooCommerce Core API. These flows serve as the compass for our testing initiatives, aiding us in concentrating our efforts where they matter most. They also diff --git a/docs/contributing/common-issues.md b/docs/contributing/common-issues.md index 21061fb339d..eacdcc337d6 100644 --- a/docs/contributing/common-issues.md +++ b/docs/contributing/common-issues.md @@ -1,4 +1,6 @@ -# Common issues +--- +post_title: Common issues +--- This page aims to document a comprehensive list of known issues, commonly encountered problems, and their solutions or workarounds. If you have encountered an issue that is not mentioned here and should be, please don't hesitate to add to the list. diff --git a/docs/contributing/deciding-pr-high-impact.md b/docs/contributing/deciding-pr-high-impact.md index 82599d3bef2..d71edd5b58e 100644 --- a/docs/contributing/deciding-pr-high-impact.md +++ b/docs/contributing/deciding-pr-high-impact.md @@ -1,4 +1,6 @@ -# How to decide if a pull request is high impact +--- +post_title: How to decide if a pull request is high impact +--- Deciding if a Pull Request should be declared High-Impact is a complex task. To achieve it, we need to assess and estimate the impact that the changes introduced in the Pull Request have in WooCommerce, which is usually a subjective task and sometimes inaccurate, due to the huge knowledge it demands of the WooCommerce product details, technical details and even customers issues history. diff --git a/docs/contributing/deprecation-in-core.md b/docs/contributing/deprecation-in-core.md index 22d70543799..fe0e0fcc54b 100644 --- a/docs/contributing/deprecation-in-core.md +++ b/docs/contributing/deprecation-in-core.md @@ -1,4 +1,6 @@ -# Deprecation in core +--- +post_title: Deprecation in core +--- Deprecation is a method of discouraging usage of a feature or practice in favour of something else without breaking backwards compatibility or totally prohibiting its usage. To quote the Wikipedia article on Deprecation: diff --git a/docs/contributing/minification-of-SCSS-and-JS.md b/docs/contributing/minification-of-SCSS-and-JS.md index 62b4226f232..c59b27fd417 100644 --- a/docs/contributing/minification-of-SCSS-and-JS.md +++ b/docs/contributing/minification-of-SCSS-and-JS.md @@ -1,5 +1,7 @@ -# Minification of SCSS and JS +--- +post_title: Minification of SCSS and JS +--- ## SCSS diff --git a/docs/contributing/naming-conventions.md b/docs/contributing/naming-conventions.md index 4406eeb36bc..736437c4a00 100644 --- a/docs/contributing/naming-conventions.md +++ b/docs/contributing/naming-conventions.md @@ -1,4 +1,6 @@ -# Naming conventions +--- +post_title: Naming conventions +--- ## PHP diff --git a/docs/contributing/string-localisation-guidelines.md b/docs/contributing/string-localisation-guidelines.md index f16a9047923..e1aa5296b83 100644 --- a/docs/contributing/string-localisation-guidelines.md +++ b/docs/contributing/string-localisation-guidelines.md @@ -1,4 +1,6 @@ -# String localization guidelines +--- +post_title: String localization guidelines +--- 1. Use `woocommerce` textdomain in all strings. 2. When using dynamic strings in printf/sprintf, if you are replacing > 1 string use numbered args. e.g. `Test %s string %s.` would be `Test %1$s string %2$s.` diff --git a/docs/contributing/woocommerce-git-flow.md b/docs/contributing/woocommerce-git-flow.md index 4c57f1f71d5..a915a857909 100644 --- a/docs/contributing/woocommerce-git-flow.md +++ b/docs/contributing/woocommerce-git-flow.md @@ -1,4 +1,6 @@ -# WooCommerce Git flow +--- +post_title: WooCommerce Git flow +--- For core development, we use the following structure and flow. diff --git a/docs/data-management/crud-objects.md b/docs/data-management/crud-objects.md index 0ea7dee715a..1564a94d3ad 100644 --- a/docs/data-management/crud-objects.md +++ b/docs/data-management/crud-objects.md @@ -1,4 +1,6 @@ -# Developing using WooCommerce CRUD objects +--- +post_title: Developing using WooCommerce CRUD objects +--- CRUD is an abbreviation of the four basic operations you can do to a database or resource – Create, Read, Update, Delete. diff --git a/docs/data-management/data-stores.md b/docs/data-management/data-stores.md index 33af81a961f..f2dfcf69010 100644 --- a/docs/data-management/data-stores.md +++ b/docs/data-management/data-stores.md @@ -1,4 +1,6 @@ -# Data stores +--- +post_title: Data stores +--- ## Introduction diff --git a/docs/extension-development/adding-a-section-to-a-settings-tab.md b/docs/extension-development/adding-a-section-to-a-settings-tab.md index a90904088c7..676f64d0b76 100644 --- a/docs/extension-development/adding-a-section-to-a-settings-tab.md +++ b/docs/extension-development/adding-a-section-to-a-settings-tab.md @@ -1,5 +1,7 @@ -# Adding a section to a settings tab +--- +post_title: Adding a section to a settings tab +--- When you’re adding building an extension for WooCommerce that requires settings of some kind, it’s important to ask yourself: **Where do they belong?** If your extension just has a couple of simple settings, do you really need to create a new tab specifically for it? Most likely the answer is no. diff --git a/docs/extension-development/building-your-first-extension.md b/docs/extension-development/building-your-first-extension.md index 3a0177118f2..57a5b691ded 100644 --- a/docs/extension-development/building-your-first-extension.md +++ b/docs/extension-development/building-your-first-extension.md @@ -1,4 +1,6 @@ -# Building your first extension +--- +post_title: Building your first extension +--- The easiest way to get started building an extension is to use the built-in extension generator that is included alongside WooCommerce Admin. This utility is maintained as part of the codebase for WooCommerce Admin, so it includes up-to-date tools and many preconfigured settings for building modern extensions that take advantage of the [React-powered](https://react.dev/) user experience available in current versions of WordPress and WooCommerce. diff --git a/docs/extension-development/class-reference.md b/docs/extension-development/class-reference.md index d37dee8654f..ac5207edca5 100644 --- a/docs/extension-development/class-reference.md +++ b/docs/extension-development/class-reference.md @@ -1,5 +1,7 @@ -# Classes in WooCommerce +--- +post_title: Classes in WooCommerce +--- ## [List of Classes in WooCommerce](https://github.com/woocommerce/woocommerce/blob/trunk/docs/extension-development/class-reference#section-1) diff --git a/docs/extension-development/development-environment.md b/docs/extension-development/development-environment.md index 1b5cc2b0ebf..3018c983368 100644 --- a/docs/extension-development/development-environment.md +++ b/docs/extension-development/development-environment.md @@ -1,4 +1,6 @@ -# Setting up your development environment +--- +post_title: Setting up your development environment +--- ## Introduction diff --git a/docs/extension-development/extension-developer-handbook.md b/docs/extension-development/extension-developer-handbook.md index 722d0a218a6..1accd3a960d 100644 --- a/docs/extension-development/extension-developer-handbook.md +++ b/docs/extension-development/extension-developer-handbook.md @@ -1,4 +1,6 @@ -# WooCommerce extension developer handbook +--- +post_title: WooCommerce extension developer handbook +--- Want to create a plugin to extend WooCommerce? WooCommerce extensions are the same as regular WordPress plugins. For more information, visit [Writing a plugin](https://developer.wordpress.org/plugins/). diff --git a/docs/extension-development/gdpr-compliance.md b/docs/extension-development/gdpr-compliance.md index b1f04ff6cff..311fb7c0751 100644 --- a/docs/extension-development/gdpr-compliance.md +++ b/docs/extension-development/gdpr-compliance.md @@ -1,4 +1,6 @@ -# GDPR Compliance Guidelines for WooCommerce Extensions +--- +post_title: GDPR Compliance Guidelines for WooCommerce Extensions +--- ## Introduction diff --git a/docs/extension-development/handling-deactivation-and-uninstallation.md b/docs/extension-development/handling-deactivation-and-uninstallation.md index 4733ddf7b5f..3e3b1aaeef6 100644 --- a/docs/extension-development/handling-deactivation-and-uninstallation.md +++ b/docs/extension-development/handling-deactivation-and-uninstallation.md @@ -1,4 +1,6 @@ -# Handling deactivation and uninstallation +--- +post_title: Handling deactivation and uninstallation +--- ## Introduction diff --git a/docs/extension-development/handling-merchant-onboarding.md b/docs/extension-development/handling-merchant-onboarding.md index d2fb37168ff..3a51e461a37 100644 --- a/docs/extension-development/handling-merchant-onboarding.md +++ b/docs/extension-development/handling-merchant-onboarding.md @@ -1,4 +1,6 @@ -# Handling merchant onboarding +--- +post_title: Handling merchant onboarding +--- ## Introduction diff --git a/docs/extension-development/how-to-add-your-own-store-management-links.md b/docs/extension-development/how-to-add-your-own-store-management-links.md index 84b35a04c98..060f56fac4d 100644 --- a/docs/extension-development/how-to-add-your-own-store-management-links.md +++ b/docs/extension-development/how-to-add-your-own-store-management-links.md @@ -1,4 +1,6 @@ -# Adding store management links +--- +post_title: Adding store management links +--- ## Introduction diff --git a/docs/extension-development/how-to-design-a-simple-extension.md b/docs/extension-development/how-to-design-a-simple-extension.md index 3f1962b42ce..1e644521b39 100644 --- a/docs/extension-development/how-to-design-a-simple-extension.md +++ b/docs/extension-development/how-to-design-a-simple-extension.md @@ -1,4 +1,6 @@ -# How to design a simple extension +--- +post_title: How to design a simple extension +--- ## Introduction diff --git a/docs/extension-development/implementing-settings.md b/docs/extension-development/implementing-settings.md index 35c650b97e5..f89b5555e7a 100644 --- a/docs/extension-development/implementing-settings.md +++ b/docs/extension-development/implementing-settings.md @@ -1,4 +1,6 @@ -# Implementing settings for extensions +--- +post_title: Implementing settings for extensions +--- If you’re customizing WooCommerce or adding your own functionality to it you’ll probably need a settings page of some sort. One of the easiest ways to create a settings page is by taking advantage of the [`WC_Integration` class](https://woocommerce.github.io/code-reference/classes/WC-Integration.html 'WC_Integration Class'). Using the Integration class will automatically create a new settings page under **WooCommerce > Settings > Integrations** and it will automatically save, and sanitize your data for you. We’ve created this tutorial so you can see how to create a new integration. diff --git a/docs/extension-development/readme.md b/docs/extension-development/readme.md index b4faebd1241..b6b2d647196 100644 --- a/docs/extension-development/readme.md +++ b/docs/extension-development/readme.md @@ -1,4 +1,8 @@ -# Extension development +--- +category_title: Extension Development +category_slug: extension-development +post_title: Extension development +--- > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/extension-development/settings-api.md b/docs/extension-development/settings-api.md index 35f1dce1d72..6078ceca42a 100644 --- a/docs/extension-development/settings-api.md +++ b/docs/extension-development/settings-api.md @@ -1,4 +1,6 @@ -# Settings API +--- +post_title: Settings API +--- The WooCommerce Settings API is used by extensions to display, save, and load settings. The best way to make use of the API in your extension is to create a class that extends the `WC_Settings_API` class: diff --git a/docs/extension-development/tools-for-low-code-development.md b/docs/extension-development/tools-for-low-code-development.md index 61f45b8b9c0..0db74def080 100644 --- a/docs/extension-development/tools-for-low-code-development.md +++ b/docs/extension-development/tools-for-low-code-development.md @@ -1,4 +1,6 @@ -# Building blocks for low code builders +--- +post_title: Building blocks for low code builders +--- ## Introduction diff --git a/docs/extension-development/using-custom-attributes-in-menus.md b/docs/extension-development/using-custom-attributes-in-menus.md index 2e2bfa5a577..09e910382a2 100644 --- a/docs/extension-development/using-custom-attributes-in-menus.md +++ b/docs/extension-development/using-custom-attributes-in-menus.md @@ -1,11 +1,15 @@ -# Using custom attributes in menus and taxonomy archives +--- +post_title: Using custom attributes in menus and taxonomy archives +--- Attributes that can be used for the layered nav are a custom taxonomy, which means you can display them in menus, or display products by attributes. This requires some work on your part, and archives must be enabled. > **Note:** This is a **Developer level** doc. If you are unfamiliar with code/templates and resolving potential conflicts, select a [WooExpert or Developer](https://woo.com/customizations/) for assistance. We are unable to provide support for customizations under our [Support Policy](https://woo.com/support-policy/). -# Register the taxonomy for menus +--- +post_title: Register the taxonomy for menus +--- When registering taxonomies for your custom attributes, WooCommerce calls the following hook: @@ -28,7 +32,9 @@ Custom attribute slugs are prefixed with `pa_`, so an attribute called `size` wo Now use your attribute in **Appearance > Menus**. You will notice, however, that it has default blog styling when you click on a link to your taxonomy term. -# Create a template +--- +post_title: Create a template +--- You need to theme your attribute to make it display products as you want. To do this: diff --git a/docs/extension-development/woocommerce-plugin-api-callback.md b/docs/extension-development/woocommerce-plugin-api-callback.md index 9eeebde6a8b..634bfac0734 100644 --- a/docs/extension-development/woocommerce-plugin-api-callback.md +++ b/docs/extension-development/woocommerce-plugin-api-callback.md @@ -1,4 +1,6 @@ -# WooCommerce Plugin API Callback Documentation +--- +post_title: WooCommerce Plugin API Callback Documentation +--- ## Overview diff --git a/docs/getting-started/debugging.md b/docs/getting-started/debugging.md index 83fe998a691..3c3bcbf8af2 100644 --- a/docs/getting-started/debugging.md +++ b/docs/getting-started/debugging.md @@ -1,4 +1,6 @@ -# Resources for debugging +--- +post_title: Resources for debugging +--- ## WordPress diff --git a/docs/getting-started/developer-resources.md b/docs/getting-started/developer-resources.md index c2caeb97afa..05d43c0adf8 100644 --- a/docs/getting-started/developer-resources.md +++ b/docs/getting-started/developer-resources.md @@ -1,4 +1,6 @@ -# WooCommerce developer resources +--- +post_title: WooCommerce developer resources +--- This guide is a great starting point for WooCommerce development. From setting up your first online store to diving deep into advanced features, you'll find what you need here. New to WooCommerce? Start with the basics. Experienced and looking for specific documentation or community discussions? We've got that covered too. Navigate through the sections below to find the resources tailored for you. diff --git a/docs/getting-started/developer-tools.md b/docs/getting-started/developer-tools.md index f6b58c87714..39579ed14b4 100644 --- a/docs/getting-started/developer-tools.md +++ b/docs/getting-started/developer-tools.md @@ -1,4 +1,6 @@ -# WooCommerce developer tools +--- +post_title: WooCommerce developer tools +--- This guide provides an overview of essential tools and libraries for WooCommerce development. It's intended for developers looking to enhance their WooCommerce projects efficiently. diff --git a/docs/getting-started/readme.md b/docs/getting-started/readme.md index 3b56b355434..04a4ffe3fa0 100644 --- a/docs/getting-started/readme.md +++ b/docs/getting-started/readme.md @@ -1,4 +1,8 @@ -# Getting started +--- +category_title: Getting Started +category_slug: getting-started +post_title: Getting started +--- > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/getting-started/set-up-a-child-theme.md b/docs/getting-started/set-up-a-child-theme.md index 13885b93b05..d5798796c8c 100644 --- a/docs/getting-started/set-up-a-child-theme.md +++ b/docs/getting-started/set-up-a-child-theme.md @@ -1,4 +1,6 @@ -# Set up and use a child theme +--- +post_title: Set up and use a child theme +--- **Note:** This document is intended for creating and using classic child themes. For a comprehensive guide on creating a child block theme and understanding the differences between a classic and block theme, please refer to [this detailed documentation](https://learn.wordpress.org/lesson-plan/create-a-basic-child-theme-for-block-themes/). diff --git a/docs/getting-started/woocommerce-endpoints.md b/docs/getting-started/woocommerce-endpoints.md index c0260146dd6..e00dea3ac7c 100644 --- a/docs/getting-started/woocommerce-endpoints.md +++ b/docs/getting-started/woocommerce-endpoints.md @@ -1,4 +1,6 @@ -# WooCommerce Endpoints +--- +post_title: WooCommerce Endpoints +--- **Note:** We are unable to provide support for customizations under our **[Support Policy](https://woo.com/support-policy/)**. If you need to further customize a snippet, or extend its functionality, we highly recommend [**Codeable**](https://codeable.io/?ref=z4Hnp), or a [**Certified WooExpert**](https://woo.com/experts/). diff --git a/docs/high-performance-order-storage/README.md b/docs/high-performance-order-storage/README.md index 1f926a239e1..e70b5f907b1 100644 --- a/docs/high-performance-order-storage/README.md +++ b/docs/high-performance-order-storage/README.md @@ -1,4 +1,6 @@ -# High Performance Order Storage (HPOS) +--- +post_title: High Performance Order Storage (HPOS) +--- WooCommerce has traditionally stored store orders and related order information (like refunds) as custom WordPress post types or post meta records. This comes with performance issues. diff --git a/docs/high-performance-order-storage/enable-hpos.md b/docs/high-performance-order-storage/enable-hpos.md index 09e28fa8c39..800201bc347 100644 --- a/docs/high-performance-order-storage/enable-hpos.md +++ b/docs/high-performance-order-storage/enable-hpos.md @@ -1,4 +1,6 @@ -# How to enable HPOS +--- +post_title: How to enable HPOS +--- From WooCommerce 8.2, released on October 2023, HPOS is enabled by default for new installations. Existing stores can switch to the “High-Performance Order Storage” from “WordPress Posts Storage” by following the below steps. diff --git a/docs/localization-translation/translating-woocommerce.md b/docs/localization-translation/translating-woocommerce.md index 0707d7ca5ab..6871de7e1ce 100644 --- a/docs/localization-translation/translating-woocommerce.md +++ b/docs/localization-translation/translating-woocommerce.md @@ -1,4 +1,6 @@ -# Translating WooCommerce +--- +post_title: Translating WooCommerce +--- WooCommerce is already translated into several languages and is translation-ready right out of the box. All that’s needed is a translation file for your language. diff --git a/docs/payments/payment-gateway-api.md b/docs/payments/payment-gateway-api.md index 2da379ef13c..fa3d66f0929 100644 --- a/docs/payments/payment-gateway-api.md +++ b/docs/payments/payment-gateway-api.md @@ -1,4 +1,6 @@ -# Payment gateway API +--- +post_title: Payment gateway API +--- Payment gateways in WooCommerce are class based and can be added through traditional plugins. This guide provides an intro to gateway development. diff --git a/docs/payments/payment-gateway-plugin-base.md b/docs/payments/payment-gateway-plugin-base.md index b02f0907185..8190456a2e0 100644 --- a/docs/payments/payment-gateway-plugin-base.md +++ b/docs/payments/payment-gateway-plugin-base.md @@ -1,4 +1,6 @@ -# WooCommerce payment gateway plugin base +--- +post_title: WooCommerce payment gateway plugin base +--- This code can be used as a base to create your own simple custom payment gateway for WooCommerce. If not used in a custom plugin, you need to add this code to your child theme’s functions.php file or via a plugin that allows custom functions to be added, such as the [Code snippets](https://wordpress.org/plugins/code-snippets/) plugin. Please don’t add custom code directly to your parent theme’s functions.php file as this will be wiped entirely when you update the theme. diff --git a/docs/payments/payment-token-api.md b/docs/payments/payment-token-api.md index e73c4780a81..2d59de13863 100644 --- a/docs/payments/payment-token-api.md +++ b/docs/payments/payment-token-api.md @@ -1,4 +1,6 @@ -# Payment token API +--- +post_title: Payment token API +--- WooCommerce 2.6 introduced an API for storing and managing payment tokens for gateways. Users can also manage these tokens from their account settings and choose from saved payment tokens on checkout. diff --git a/docs/product-editor-development/README.md b/docs/product-editor-development/README.md index 1c76c815348..5174928486b 100644 --- a/docs/product-editor-development/README.md +++ b/docs/product-editor-development/README.md @@ -1,4 +1,6 @@ -# Product Editor Development Handbook +--- +post_title: Product Editor Development Handbook +--- > ⚠️ **Notice:** This documentation is currently a **work in progress**. Please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/product-editor-development/block-template-lifecycle.md b/docs/product-editor-development/block-template-lifecycle.md index 60d43e2a054..d8be8f3736f 100644 --- a/docs/product-editor-development/block-template-lifecycle.md +++ b/docs/product-editor-development/block-template-lifecycle.md @@ -1,4 +1,6 @@ -# Block template lifecycle +--- +post_title: Block template lifecycle +--- A block template is a tree structure of blocks that define the product editor's form structure. diff --git a/docs/product-editor-development/product-editor-extensibility-guidelines.md b/docs/product-editor-development/product-editor-extensibility-guidelines.md index ea7fba8fb3d..b76a5d3fa2f 100644 --- a/docs/product-editor-development/product-editor-extensibility-guidelines.md +++ b/docs/product-editor-development/product-editor-extensibility-guidelines.md @@ -1,4 +1,6 @@ -# Product editor extensibility guidelines +--- +post_title: Product editor extensibility guidelines +--- > ⚠️ **Notice:** These guidelines are currently a **work in progress**. Please be aware that some details might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/quality-and-best-practices/coding-standards.md b/docs/quality-and-best-practices/coding-standards.md index 83948d60db7..32086cdb516 100644 --- a/docs/quality-and-best-practices/coding-standards.md +++ b/docs/quality-and-best-practices/coding-standards.md @@ -1,4 +1,6 @@ -# Coding standards for the code snippets within the WooCommerce documentation +--- +post_title: Coding standards for the code snippets within the WooCommerce documentation +--- ## Position of hooks diff --git a/docs/quality-and-best-practices/core-critical-flows.md b/docs/quality-and-best-practices/core-critical-flows.md index affda6def8e..b50e811283a 100644 --- a/docs/quality-and-best-practices/core-critical-flows.md +++ b/docs/quality-and-best-practices/core-critical-flows.md @@ -1,4 +1,6 @@ -# WooCommerce core critical flows +--- +post_title: WooCommerce core critical flows +--- We have identified what we consider to be our most critical user flows within WooCommerce Core. These flows will help us focus and prioritize our testing efforts. They will also help us consider the impact of changes and priority of issues. diff --git a/docs/quality-and-best-practices/css-sass-naming-conventions.md b/docs/quality-and-best-practices/css-sass-naming-conventions.md index 263fd834875..69a66d2da68 100644 --- a/docs/quality-and-best-practices/css-sass-naming-conventions.md +++ b/docs/quality-and-best-practices/css-sass-naming-conventions.md @@ -1,4 +1,6 @@ -# CSS/Sass naming conventions +--- +post_title: CSS/Sass naming conventions +--- Table of Contents: diff --git a/docs/quality-and-best-practices/grammar-punctuation-capitalization.md b/docs/quality-and-best-practices/grammar-punctuation-capitalization.md index dc992ba5e3f..6759163d71b 100644 --- a/docs/quality-and-best-practices/grammar-punctuation-capitalization.md +++ b/docs/quality-and-best-practices/grammar-punctuation-capitalization.md @@ -1,4 +1,6 @@ -# WooCommerce grammar, punctuation and capitalization guide +--- +post_title: WooCommerce grammar, punctuation and capitalization guide +--- Following grammar, punctuation and style guidelines helps keep our presentation consistent. Users have a better experience if they know what to expect and where to find the information they need. diff --git a/docs/quality-and-best-practices/naming-conventions.md b/docs/quality-and-best-practices/naming-conventions.md index 4e528ba7275..9772cfebf8d 100644 --- a/docs/quality-and-best-practices/naming-conventions.md +++ b/docs/quality-and-best-practices/naming-conventions.md @@ -1,4 +1,6 @@ -# Naming conventions +--- +post_title: Naming conventions +--- Table of Contents: diff --git a/docs/quality-and-best-practices/performance-optimization.md b/docs/quality-and-best-practices/performance-optimization.md index dfdf63a9af5..9ed89e671ad 100644 --- a/docs/quality-and-best-practices/performance-optimization.md +++ b/docs/quality-and-best-practices/performance-optimization.md @@ -1,4 +1,6 @@ -# Performance optimization for WooCommerce stores +--- +post_title: Performance optimization for WooCommerce stores +--- ## Introduction diff --git a/docs/quality-and-best-practices/readme.md b/docs/quality-and-best-practices/readme.md index d2d60951cb0..5744737eb6d 100644 --- a/docs/quality-and-best-practices/readme.md +++ b/docs/quality-and-best-practices/readme.md @@ -1,4 +1,8 @@ -# Quality and best practices +--- +category_title: Quality Practices Best And +category_slug: quality-and-best-practices +post_title: Quality and best practices +--- > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/quality-and-best-practices/removing-product-product-category-or-shop-from-the-url.md b/docs/quality-and-best-practices/removing-product-product-category-or-shop-from-the-url.md index 4bc1015a57d..0be99a62af2 100644 --- a/docs/quality-and-best-practices/removing-product-product-category-or-shop-from-the-url.md +++ b/docs/quality-and-best-practices/removing-product-product-category-or-shop-from-the-url.md @@ -1,5 +1,7 @@ -# Removing /product/ , /product-category/ , or /shop/ from the URLs +--- +post_title: Removing /product/ , /product-category/ , or /shop/ from the URLs +--- **Note:** This is a **Developer level** doc. If you are unfamiliar with code/templates and resolving potential conflicts, select a [WooExpert or Developer](https://woo.com/customizations/) for assistance. We are unable to provide support for customizations under our [Support Policy](https://woo.com/support-policy/). diff --git a/docs/quality-and-best-practices/writing-high-quality-testing-instructions.md b/docs/quality-and-best-practices/writing-high-quality-testing-instructions.md index 5e0977a138b..dd9b30b1458 100644 --- a/docs/quality-and-best-practices/writing-high-quality-testing-instructions.md +++ b/docs/quality-and-best-practices/writing-high-quality-testing-instructions.md @@ -1,4 +1,6 @@ -# Writing high quality testing instructions +--- +post_title: Writing high quality testing instructions +--- ## Introduction diff --git a/docs/reporting/adding-columns-to-analytics-reports-and-csv-downloads.md b/docs/reporting/adding-columns-to-analytics-reports-and-csv-downloads.md index 5e0727131ea..0b494457317 100644 --- a/docs/reporting/adding-columns-to-analytics-reports-and-csv-downloads.md +++ b/docs/reporting/adding-columns-to-analytics-reports-and-csv-downloads.md @@ -1,4 +1,6 @@ -# Adding columns to analytics reports and CSV downloads +--- +post_title: Adding columns to analytics reports and CSV downloads +--- Adding columns to analytics reports are a really interesting way to add functionality to WooCommerce. New data can be consumed in the table view of the user interface and in your user's favourite spreadsheet or third party application by generating a CSV. diff --git a/docs/reporting/extending-woocommerce-admin-reports.md b/docs/reporting/extending-woocommerce-admin-reports.md index f912605d4b7..15110dca030 100644 --- a/docs/reporting/extending-woocommerce-admin-reports.md +++ b/docs/reporting/extending-woocommerce-admin-reports.md @@ -1,4 +1,6 @@ -# Extending WooCommerce Analytics reports +--- +post_title: Extending WooCommerce Analytics reports +--- ## Introduction diff --git a/docs/reporting/readme.md b/docs/reporting/readme.md index 1063addba3d..79d55acab94 100644 --- a/docs/reporting/readme.md +++ b/docs/reporting/readme.md @@ -1,4 +1,8 @@ -# Reporting +--- +category_title: Reporting +category_slug: reporting +post_title: Reporting +--- > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/rest-api/getting-started.md b/docs/rest-api/getting-started.md index 0777ce5211f..8451f5ed7f2 100644 --- a/docs/rest-api/getting-started.md +++ b/docs/rest-api/getting-started.md @@ -1,4 +1,6 @@ -# Getting started with the REST API +--- +post_title: Getting started with the REST API +--- The REST API is a powerful part of WooCommerce which lets you read and write various parts of WooCommerce data such as orders, products, coupons, customers, and shipping zones. diff --git a/docs/rest-api/readme.md b/docs/rest-api/readme.md index 5033ef6331c..7c206e3d48e 100644 --- a/docs/rest-api/readme.md +++ b/docs/rest-api/readme.md @@ -1,4 +1,8 @@ -# REST API +--- +category_title: Rest Api +category_slug: rest-api +post_title: REST API +--- > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/security/readme.md b/docs/security/readme.md index 3d864e93e08..f64c00b4cc4 100644 --- a/docs/security/readme.md +++ b/docs/security/readme.md @@ -1,4 +1,8 @@ -# Security +--- +category_title: Security +category_slug: security +post_title: Security +--- > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/security/reporting-security-issues.md b/docs/security/reporting-security-issues.md index 7ee31b38c0e..64ef67f8fc4 100644 --- a/docs/security/reporting-security-issues.md +++ b/docs/security/reporting-security-issues.md @@ -1,4 +1,6 @@ -# Reporting security issues +--- +post_title: Reporting security issues +--- WooCommerce cares deeply about security and works hard to keep our merchants and their customers safe. diff --git a/docs/security/security-best-practices.md b/docs/security/security-best-practices.md index 3df5d766297..2a27d7bdf21 100644 --- a/docs/security/security-best-practices.md +++ b/docs/security/security-best-practices.md @@ -1,4 +1,6 @@ -# WooCommerce security best practices +--- +post_title: WooCommerce security best practices +--- ## Introduction diff --git a/docs/shipping/shipping-method-api.md b/docs/shipping/shipping-method-api.md index 3845ee98083..576365fb158 100644 --- a/docs/shipping/shipping-method-api.md +++ b/docs/shipping/shipping-method-api.md @@ -1,4 +1,6 @@ -# Shipping method API +--- +post_title: Shipping method API +--- WooCommerce has a shipping method API which plugins can use to add their own rates. This article will take you through the steps to creating a new shipping method and interacting with the API. diff --git a/docs/style-guide.md b/docs/style-guide.md index 9bff55bbc2d..8201516d0ea 100644 --- a/docs/style-guide.md +++ b/docs/style-guide.md @@ -1,4 +1,6 @@ -# Technical documentation style guide +--- +post_title: Technical documentation style guide +--- This style guide is intended to provide guidelines for creating effective and user-friendly tutorials and how-to guides for WooCommerce technical documentation that will live in repo and be editable and iterative by open source contributors and WooCommerce teams. @@ -62,7 +64,9 @@ Note: While we've outlined specific rules above, all other default linting rules - Use the ATX-style (`#`) for headers. ```markdown +--- # This is an H1 +--- ## This is an H2 ``` diff --git a/docs/theme-development/README.md b/docs/theme-development/README.md index c8fc76884a9..3912e2460a0 100644 --- a/docs/theme-development/README.md +++ b/docs/theme-development/README.md @@ -1,4 +1,6 @@ -# Theme Design and Development at Woo +--- +post_title: Theme Design and Development at Woo +--- ## Classic Themes diff --git a/docs/theme-development/classic-theme-developer-handbook.md b/docs/theme-development/classic-theme-developer-handbook.md index 0b18413418e..0f65456904f 100644 --- a/docs/theme-development/classic-theme-developer-handbook.md +++ b/docs/theme-development/classic-theme-developer-handbook.md @@ -1,4 +1,6 @@ -# Classic Theme Developer Handbook +--- +post_title: Classic Theme Developer Handbook +--- --- diff --git a/docs/theme-development/conditional-tags.md b/docs/theme-development/conditional-tags.md index 7faa554f739..da665fe1100 100644 --- a/docs/theme-development/conditional-tags.md +++ b/docs/theme-development/conditional-tags.md @@ -1,4 +1,6 @@ -# Conditional tags +--- +post_title: Conditional tags +--- **Note:** This is a **Developer level** doc. If you are unfamiliar with code/tags and resolving potential conflicts, select a [WooExpert or Developer](https://woo.com/customizations/) for assistance. We are unable to provide support for customizations under our [Support Policy](https://woo.com/support-policy/). diff --git a/docs/theme-development/fixing-outdated-woocommerce-templates.md b/docs/theme-development/fixing-outdated-woocommerce-templates.md index 8ea2f6f9bf2..e4ef0cab4c3 100644 --- a/docs/theme-development/fixing-outdated-woocommerce-templates.md +++ b/docs/theme-development/fixing-outdated-woocommerce-templates.md @@ -1,4 +1,6 @@ -# Fixing outdated WooCommerce templates +--- +post_title: Fixing outdated WooCommerce templates +--- ## Template Updates and Changes diff --git a/docs/theme-development/theme-design-ux-guidelines.md b/docs/theme-development/theme-design-ux-guidelines.md index 4b0aadb68b2..aeca6c2698a 100644 --- a/docs/theme-development/theme-design-ux-guidelines.md +++ b/docs/theme-development/theme-design-ux-guidelines.md @@ -1,4 +1,6 @@ -# Theme design and user experience guidelines +--- +post_title: Theme design and user experience guidelines +--- This guide covers general guidelines and best practices to follow in order to ensure your theme experience aligns with ecommerce industry standards and WooCommerce for providing a great online shopping experience, maximizing sales, ensuring ease of use, seamless integration, and strong UX adoption. diff --git a/docs/tutorials/adding-a-custom-field-to-variable-products.md b/docs/tutorials/adding-a-custom-field-to-variable-products.md index 626364f85ea..085999aedb1 100644 --- a/docs/tutorials/adding-a-custom-field-to-variable-products.md +++ b/docs/tutorials/adding-a-custom-field-to-variable-products.md @@ -1,4 +1,6 @@ -# Adding a custom field to simple and variable products +--- +post_title: Adding a custom field to simple and variable products +--- In this tutorial you will learn how to create a custom field for a product and show it in your store. Together we will set up the skeleton plugin, and learn about WP naming conventions and WooCommerce hooks. In the end, you will have a functioning plugin for adding a custom field. diff --git a/docs/tutorials/adding-actions-and-filters.md b/docs/tutorials/adding-actions-and-filters.md index 41ec27be0f2..a60358b9d85 100644 --- a/docs/tutorials/adding-actions-and-filters.md +++ b/docs/tutorials/adding-actions-and-filters.md @@ -1,4 +1,6 @@ -# Adding actions and filters +--- +post_title: Adding actions and filters +--- Like many WordPress plugins, WooCommerce provides a range of actions and filters through which developers can extend and modify the platform. diff --git a/docs/tutorials/readme.md b/docs/tutorials/readme.md index 3a4428d3c45..e0b9632f0ac 100644 --- a/docs/tutorials/readme.md +++ b/docs/tutorials/readme.md @@ -1,4 +1,8 @@ -# Tutorials +--- +category_title: Tutorials +category_slug: tutorials +post_title: Tutorials +--- > ⚠️ **Notice:** This documentation is currently a **work in progress**. While it's open to the public for transparency and collaboration, please be aware that some sections might be incomplete or subject to change. We appreciate your patience and welcome any contributions! diff --git a/docs/user-experience/accessibility.md b/docs/user-experience/accessibility.md index 77b6c204749..a385b46c4ae 100644 --- a/docs/user-experience/accessibility.md +++ b/docs/user-experience/accessibility.md @@ -1,4 +1,6 @@ -# User experience guidelines: accessibility +--- +post_title: User experience guidelines: accessibility +--- ## Accessibility diff --git a/docs/user-experience/best-practices.md b/docs/user-experience/best-practices.md index 5f7cf49d941..85e710e7823 100644 --- a/docs/user-experience/best-practices.md +++ b/docs/user-experience/best-practices.md @@ -1,4 +1,6 @@ -# User experience guidelines: best practices +--- +post_title: User experience guidelines: best practices +--- ## Best practices diff --git a/docs/user-experience/colors.md b/docs/user-experience/colors.md index 63688441921..62917492396 100644 --- a/docs/user-experience/colors.md +++ b/docs/user-experience/colors.md @@ -1,4 +1,6 @@ -# User experience guidelines: colors +--- +post_title: User experience guidelines: colors +--- ## Colors diff --git a/docs/user-experience/notices.md b/docs/user-experience/notices.md index e568b71fb39..abb0c89fc25 100644 --- a/docs/user-experience/notices.md +++ b/docs/user-experience/notices.md @@ -1,4 +1,6 @@ -# User experience guidelines: notices +--- +post_title: User experience guidelines: notices +--- ## Notices diff --git a/docs/user-experience/onboarding.md b/docs/user-experience/onboarding.md index a1b0d3be432..91ff6aaac49 100644 --- a/docs/user-experience/onboarding.md +++ b/docs/user-experience/onboarding.md @@ -1,4 +1,6 @@ -# User experience guidelines: onboarding +--- +post_title: User experience guidelines: onboarding +--- ## Onboarding diff --git a/docs/user-experience/task-list-and-inbox.md b/docs/user-experience/task-list-and-inbox.md index e1ff185d04a..9d2cec1baff 100644 --- a/docs/user-experience/task-list-and-inbox.md +++ b/docs/user-experience/task-list-and-inbox.md @@ -1,4 +1,6 @@ -# User experience guidelines: task list and inbox +--- +post_title: User experience guidelines: task list and inbox +--- ## Task List & Inbox diff --git a/docs/user-experience/user-experience-guidelines.md b/docs/user-experience/user-experience-guidelines.md index e9efcd55938..23a442af830 100644 --- a/docs/user-experience/user-experience-guidelines.md +++ b/docs/user-experience/user-experience-guidelines.md @@ -1,4 +1,6 @@ -# User experience guidelines +--- +post_title: User experience guidelines +--- This guide covers general guidelines, and best practices to follow in order to ensure your product experience aligns with WooCommerce for ease of use, seamless integration, and strong adoption. diff --git a/docs/utilities/configuring-caching-plugins.md b/docs/utilities/configuring-caching-plugins.md index 9fdf2571ab2..a07d6860e2c 100644 --- a/docs/utilities/configuring-caching-plugins.md +++ b/docs/utilities/configuring-caching-plugins.md @@ -1,4 +1,6 @@ -# Configuring Caching Plugins for WooCommerce +--- +post_title: Configuring Caching Plugins for WooCommerce +--- ## Excluding Pages from the Cache @@ -62,35 +64,51 @@ Check out the following WordPress.org Support forum post on[ how cookies may be ```text Add this to vcl_recv above "if (req.http.cookie) {": -# Unset Cookies except for WordPress admin and WooCommerce pages +--- +post_title: Unset Cookies except for WordPress admin and WooCommerce pages +--- if (!(req.url ~ "(wp-login|wp-admin|cart|my-account/*|wc-api*|checkout|addons|logout|lost-password|product/*)")) { unset req.http.cookie; } -# Pass through the WooCommerce dynamic pages +--- +post_title: Pass through the WooCommerce dynamic pages +--- if (req.url ~ "^/(cart|my-account/*|checkout|wc-api/*|addons|logout|lost-password|product/*)") { return (pass); } -# Pass through the WooCommerce add to cart +--- +post_title: Pass through the WooCommerce add to cart +--- if (req.url ~ "\?add-to-cart=" ) { return (pass); } -# Pass through the WooCommerce API +--- +post_title: Pass through the WooCommerce API +--- if (req.url ~ "\?wc-api=" ) { return (pass); } -# Block access to php admin pages via website +--- +post_title: Block access to php admin pages via website +--- if (req.url ~ "^/phpmyadmin/.*$" || req.url ~ "^/phppgadmin/.*$" || req.url ~ "^/server-status.*$") { error 403 "For security reasons, this URL is only accesible using localhost (127.0.0.1) as the hostname"; } +--- # +--- Add this to vcl_fetch: -# Unset Cookies except for WordPress admin and WooCommerce pages +--- +post_title: Unset Cookies except for WordPress admin and WooCommerce pages +--- if ( (!(req.url ~ "(wp-(login|admin)|login|cart|my-account/*|wc-api*|checkout|addons|logout|lost-password|product/*)")) || (req.request == "GET") ) { unset beresp.http.set-cookie; } +--- # +--- ``` ### Why is my Password Reset stuck in a loop? diff --git a/docs/utilities/logging.md b/docs/utilities/logging.md index 284a6a23a21..af4d7a880bd 100644 --- a/docs/utilities/logging.md +++ b/docs/utilities/logging.md @@ -1,4 +1,6 @@ -# Logging in WooCommerce +--- +post_title: Logging in WooCommerce +--- WooCommerce has its own robust system for logging, which can be used for debugging during development, catching errors on production, or even sending notifications when specific events occur. By default, WooCommerce uses this logger to record errors, warnings, and other notices that may be useful for troubleshooting problems with a store. Many extensions for WooCommerce also make use of the logger for similar purposes. diff --git a/docs/wc-cli/commands.md b/docs/wc-cli/commands.md index a5460145a3a..a49107f5ef7 100644 --- a/docs/wc-cli/commands.md +++ b/docs/wc-cli/commands.md @@ -1,4 +1,6 @@ -# WC CLI: commands +--- +post_title: WC CLI: commands +--- ## wc shop_coupon diff --git a/docs/wc-cli/overview.md b/docs/wc-cli/overview.md index 54bdca84826..cdc93dd5aaa 100644 --- a/docs/wc-cli/overview.md +++ b/docs/wc-cli/overview.md @@ -1,4 +1,6 @@ -# WC CLI: overview +--- +post_title: WC CLI: overview +--- WooCommerce CLI (WC-CLI) offers the ability to manage WooCommerce (WC) via the command-line, using WP CLI. The documentation here covers the version of WC CLI that started shipping in WC 3.0.0 and later.