woocommerce/docs

WooCommerce internal documentation

This directory contains documentation about implementation details specific parts of the WooCommerce code base. This documentation is intended for developers.

Available documents

• HPOS: Details of how the High Performance Order Storage works.

Other documents

Some directories contain documentation about their own contents, in the form of README file. The available files are listed below, if you create a new README file please add it to the corresponding list.

Available READMe files for the WooCommerce plugin:

• Root README
• i18n/languages
• includes
• lib
• packages
• src
• src/Admin/RemoteInboxNotifications
• src/Admin/RemoteInboxNotifications/Transformers
• src/Blocks
• src/Internal
• src/Internal/Admin/ProductForm
• tests
• tests/api-core-tests
• tests/e2e
• tests/e2e-pw
• tests/performance
• tests/Tools/CodeHacking

Available READMe files for the WooCommerce Admin plugin:

• Root README
• client/activity-panel
• client/activity-panel/activity-card
• client/activity-panel/activity-header
• client/analytics/report
• client/analytics/settings
• client/dashboard
• client/header
• client/marketing
• client/marketing/components/button
• client/marketing/components/card
• client/marketing/components/product-icon
• client/utils
• client/wp-admin-scripts
• docs
• docs/examples
• docs/examples/extensions
• docs/features
• docs/woocommerce.com

Available READMe files for the WooCommerce Beta Tested plugin:

• Root README
• src/tools
• userscripts