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-admin/docs/README.md

14 lines
693 B
Markdown
Raw Normal View History

Docs Project: Add markdown files, docsify to render site (https://github.com/woocommerce/woocommerce-admin/pull/337) * Add generated docs to repo, add command to regenerate docs * Add docsify to render markdown files & search from GitHub.io * Add prop type description if it exists This property is only filled in on descendent proptypes (items in a shape, for example) * Vaguely woo-themed * Tweak spacing in markdown file, add final newline to each file
2018-08-31 20:13:20 +00:00
# WooCommerce Admin
Update admin docs README.md
2022-04-13 05:32:12 +00:00
This is a javascript-driven, React-based admin interface for WooCommerce.
Docs Project: Add markdown files, docsify to render site (https://github.com/woocommerce/woocommerce-admin/pull/337) * Add generated docs to repo, add command to regenerate docs * Add docsify to render markdown files & search from GitHub.io * Add prop type description if it exists This property is only filled in on descendent proptypes (items in a shape, for example) * Vaguely woo-themed * Tweak spacing in markdown file, add final newline to each file
2018-08-31 20:13:20 +00:00
## Development
Update admin docs README.md
2022-04-13 05:32:12 +00:00
Please refer to the [WooCommerce Admin Development](https://github.com/woocommerce/woocommerce/wiki/How-to-set-up-WooCommerce-development-environment#wooCommerce-admin-development)
## End-to-end tests
Add section on "Dev Docs" (https://github.com/woocommerce/woocommerce-admin/pull/1123) * Add section on "Dev Docs" This adds information on what the devdocs are and how to view them. * Fix components link * Add docsify serve docs option * Remove npx serve bit
2018-12-18 22:49:30 +00:00
Update admin docs README.md
2022-04-13 05:32:12 +00:00
Please refer to the [WooCommerce End to End Tests](https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/tests/e2e/README.md)
## Common Issues
Add section on "Dev Docs" (https://github.com/woocommerce/woocommerce-admin/pull/1123) * Add section on "Dev Docs" This adds information on what the devdocs are and how to view them. * Fix components link * Add docsify serve docs option * Remove npx serve bit
2018-12-18 22:49:30 +00:00
Update admin docs README.md
2022-04-13 05:32:12 +00:00
If you're encountering any issue setting things up, chances are we have been there too. Please have a look at our [wiki](https://github.com/woocommerce/woocommerce/wiki/Common-Issues) for a list of common problems.