use consistent capitalization in docs titles
This commit is contained in:
parent
2b60fd5e83
commit
eec31465a0
|
@ -1,4 +1,4 @@
|
||||||
# WooCommerce Developer Documentation
|
# 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!
|
> ⚠️ **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!
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Rename a country
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Useful Core Functions
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# CSS SASS coding guidelines and naming convetions
|
# 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;
|
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;
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# API Critical Flows
|
# API critical flows
|
||||||
|
|
||||||
In our documentation, we've pinpointed the essential user flows within the WooCommerce Core API. These flows serve as
|
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
|
the compass for our testing initiatives, aiding us in concentrating our efforts where they matter most. They also
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# How to decide if a Pull Request is High-Impact
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Deprecation in Core
|
# 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:
|
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:
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Naming Conventions
|
# Naming conventions
|
||||||
|
|
||||||
## PHP
|
## PHP
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# WooCommerce Git Flow
|
# WooCommerce Git flow
|
||||||
|
|
||||||
For core development, we use the following structure and flow.
|
For core development, we use the following structure and flow.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Data Stores
|
# Data stores
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
|
|
||||||
# Adding a Section to a Settings Tab
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# WooCommerce Extension Developer Handbook
|
# 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/).
|
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/).
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Implementing Settings for Extensions
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Extension Development
|
# 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!
|
> ⚠️ **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!
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# WooCommerce Developer Resources
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# WooCommerce Developer Tools
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Getting-started
|
# 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!
|
> ⚠️ **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!
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Payment Gateway API
|
# 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.
|
Payment gateways in WooCommerce are class based and can be added through traditional plugins. This guide provides an intro to gateway development.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Payment Token API
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Product Editor Extensibility Guidelines
|
# 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!
|
> ⚠️ **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!
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# CSS/Sass Naming Conventions
|
# CSS/Sass naming conventions
|
||||||
|
|
||||||
Table of Contents:
|
Table of Contents:
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Naming Conventions
|
# Naming conventions
|
||||||
|
|
||||||
Table of Contents:
|
Table of Contents:
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Quality and Best Practices
|
# 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!
|
> ⚠️ **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!
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Reference Code
|
# Reference code
|
||||||
|
|
||||||
> ⚠️ **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!
|
> ⚠️ **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!
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Extending WC-Admin reports
|
# Extending WooCommerce Analytics reports
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Shipping Method API
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Fixing Outdated WooCommerce Templates
|
# Fixing outdated WooCommerce templates
|
||||||
|
|
||||||
## Template Updates and Changes
|
## Template Updates and Changes
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Theme Design and User Experience Guidelines
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# User Experience Guidelines: Accessibility
|
# User experience guidelines: accessibility
|
||||||
|
|
||||||
## Accessibility
|
## Accessibility
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# User Experience Guidelines: Best Practices
|
# User experience guidelines: best practices
|
||||||
|
|
||||||
## Best practices
|
## Best practices
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# User Experience Guidelines: Colors
|
# User experience guidelines: colors
|
||||||
|
|
||||||
## Colors
|
## Colors
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# User Experience Guidelines: Notices
|
# User experience guidelines: notices
|
||||||
|
|
||||||
## Notices
|
## Notices
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# User Experience Guidelines: Onboarding
|
# User experience guidelines: onboarding
|
||||||
|
|
||||||
## Onboarding
|
## Onboarding
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# User Experience Guidelines: Task list and Inbox
|
# User experience guidelines: task list and inbox
|
||||||
|
|
||||||
## Task List & Inbox
|
## Task List & Inbox
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# User Experience Guidelines
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# WC CLI: Commands
|
# WC CLI: commands
|
||||||
|
|
||||||
## wc shop_coupon
|
## wc shop_coupon
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# WC CLI: Overview
|
# 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.
|
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.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue