60 lines
3.8 KiB
Markdown
60 lines
3.8 KiB
Markdown
# 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](HPOS.md): 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`](../plugins/woocommerce/README.md)
|
|
* [`i18n/languages`](../plugins/woocommerce/i18n/languages/README.md)
|
|
* [`includes`](../plugins/woocommerce/includes/README.md)
|
|
* [`lib`](../plugins/woocommerce/lib/README.md)
|
|
* [`packages`](../plugins/woocommerce/packages/README.md)
|
|
* [`src`](../plugins/woocommerce/src/README.md)
|
|
* [`src/Admin/RemoteInboxNotifications`](../plugins/woocommerce/src/Admin/RemoteInboxNotifications/README.md)
|
|
* [`src/Admin/RemoteInboxNotifications/Transformers`](../plugins/woocommerce/src/Admin/RemoteInboxNotifications/Transformers/README.md)
|
|
* [`src/Blocks`](../plugins/woocommerce/src/Blocks/README.md)
|
|
* [`src/Internal`](../plugins/woocommerce/src/Internal/README.md)
|
|
* [`src/Internal/Admin/ProductForm`](../plugins/woocommerce/src/Internal/Admin/ProductForm/README.md)
|
|
* [`tests`](../plugins/woocommerce/tests/README.md)
|
|
* [`tests/api-core-tests`](../plugins/woocommerce/tests/api-core-tests/README.md)
|
|
* [`tests/e2e`](../plugins/woocommerce/tests/e2e/README.md)
|
|
* [`tests/e2e-pw`](../plugins/woocommerce/tests/e2e-pw/README.md)
|
|
* [`tests/performance`](../plugins/woocommerce/tests/performance/README.md)
|
|
* [`tests/Tools/CodeHacking`](../plugins/woocommerce/tests/Tools/CodeHacking/README.md)
|
|
|
|
Available READMe files for the WooCommerce Admin plugin:
|
|
|
|
* [`Root README`](../plugins/woocommerce-admin/README.md)
|
|
* [`client/activity-panel`](../plugins/woocommerce-admin/client/activity-panel/README.md)
|
|
* [`client/activity-panel/activity-card`](../plugins/woocommerce-admin/client/activity-panel/activity-card/README.md)
|
|
* [`client/activity-panel/activity-header`](../plugins/woocommerce-admin/client/activity-panel/activity-header/README.md)
|
|
* [`client/analytics/report`](../plugins/woocommerce-admin/client/analytics/report/README.md)
|
|
* [`client/analytics/settings`](../plugins/woocommerce-admin/client/analytics/settings/README.md)
|
|
* [`client/dashboard`](../plugins/woocommerce-admin/client/dashboard/README.md)
|
|
* [`client/header`](../plugins/woocommerce-admin/client/header/README.md)
|
|
* [`client/marketing`](../plugins/woocommerce-admin/client/marketing/README.md)
|
|
* [`client/marketing/components/button`](../plugins/woocommerce-admin/client/marketing/components/button/README.md)
|
|
* [`client/marketing/components/card`](../plugins/woocommerce-admin/client/marketing/components/card/README.md)
|
|
* [`client/marketing/components/product-icon`](../plugins/woocommerce-admin/client/marketing/components/product-icon/README.md)
|
|
* [`client/utils`](../plugins/woocommerce-admin/client/utils/README.md)
|
|
* [`client/wp-admin-scripts`](../plugins/woocommerce-admin/client/wp-admin-scripts/README.md)
|
|
* [`docs`](../plugins/woocommerce-admin/docs/README.md)
|
|
* [`docs/examples`](../plugins/woocommerce-admin/docs/examples/README.md)
|
|
* [`docs/examples/extensions`](../plugins/woocommerce-admin/docs/examples/extensions/README.md)
|
|
* [`docs/features`](../plugins/woocommerce-admin/docs/features/README.md)
|
|
* [`docs/woocommerce.com`](../plugins/woocommerce-admin/docs/woocommerce.com/README.md)
|
|
|
|
Available READMe files for the WooCommerce Beta Tested plugin:
|
|
|
|
* [`Root README`](../plugins/woocommerce-beta-tester/README.md)
|
|
* [`src/tools`](../plugins/woocommerce-beta-tester/src/tools/README.md)
|
|
* [`userscripts`](../plugins/woocommerce-beta-tester/userscripts/README.md)
|