Commit Graph

327 Commits

Author SHA1 Message Date
Kader Ibrahim S 99a39ad56e
Adds documentation for implementing WC Integration (#40772)
* First draft after HTML to markdown.

* Refactors the implement settings document.

* Adds changelog file
2023-10-23 23:03:04 +02:00
Leif Singer 810d322c43
Docs: add contributing/common-issues.md (#40768)
* add contributing/common-issues.md

* tweak wording and formatting here and there
2023-10-23 23:01:51 +02:00
Leif Singer fb3f6d95fa
add `deprecation-in-core.md` (#40765) 2023-10-23 23:01:38 +02:00
Brent MacKinnon 1570d26ec4
migrating a batch of contribution-related docs from the wiki (#40764)
* migrating a batch of contribution-related docs from the wiki

* Delete deprecation-in-core.md

* liniting
2023-10-23 23:01:25 +02:00
Brent MacKinnon 9028178d95
Create shipping-method-api.md (#40763)
* Create shipping-method-api.md

* Update shipping-method-api.md
2023-10-23 23:01:14 +02:00
Paulo Arromba 3699ecdc00
Add API Critical Flows to /docs (#40762)
* Created md file for API Critical Flows

* Added Shipping section

* Moved api-critical-flows.md to docs/contributing folder
2023-10-23 23:00:59 +02:00
Brent MacKinnon 9a10a416b0
Create payment-token-api.md (#40761)
* Create payment-token-api.md

* Create payment-gateway-api.md

* adjusting for lint

* Create payment-gateway-plugin-base.md

* Update payment-token-api.md

* Update payment-token-api.md

* adjusting for linting

* Update payment-gateway-api.md
2023-10-23 23:00:42 +02:00
Brent MacKinnon 890fb93a01
Create woocommerce-git-flow.md (#40758)
* Create woocommerce-git-flow.md

* Update woocommerce-git-flow.md

* Update woocommerce-git-flow.md
2023-10-23 23:00:26 +02:00
Brent MacKinnon 3abc6d82e6
Update developer-resources.md (#40058) 2023-10-23 23:00:13 +02:00
Brent MacKinnon 72b228fc7c
Create user-experience-guidelines.md (#39894)
* Create user-experience-guidelines.md

* Beefing up user-experience guidlines

adding media folder, and 6 new docs to create the user experience folder in our docs repo.

* UX guidelines to pass linting

* Update task-list-and-inbox.md

* Update task-list-and-inbox.md

* moving images to developer.woo.com
2023-10-23 22:59:56 +02:00
Kader Ibrahim S 6d7755813a
Adds documentation for useful functions (#40771)
Co-authored-by: Néstor Soriano <konamiman@konamiman.com>
2023-10-23 11:37:53 +02:00
Niels Lange 7f64791745
Add docs “Translating WooCommerce” (#40744) 2023-10-18 10:17:47 +07:00
nigeljamesstevenson 2b82e0b092
Migration of e2e core critical flows (#40785) 2023-10-17 10:36:26 +01:00
Miguel Pérez Pellicer 7f4d6459af
Add documentation for WooCommerce Class Reference (#40754) 2023-10-17 13:06:22 +04:00
Miguel Pérez Pellicer 49073f796e
Add documentation for Using custom attributes in menus and taxonomy archives (#40755) 2023-10-17 13:05:54 +04:00
Miguel Pérez Pellicer ff03403d3f
Add documentation for Removing /product/ , /product-category/ , or /shop/ from the URLs (#40753)
* Migrate documentation for Removing /product/ , /product-category/ , or /shop/ from the URLs

* Markdown linter
2023-10-17 12:58:59 +04:00
Miguel Pérez Pellicer cfd0ff1da8
Add documentation for Adding a Section to a Settings Tab (#40751)
* Add documentation for Adding a Section to a Settings Tab

* Modify links
2023-10-17 12:49:29 +04:00
Miguel Pérez Pellicer 6c3ed1c7d0
Revisit docs for HPOS (#40756) 2023-10-17 12:49:03 +04:00
Niels Lange 6603e2bcad
List other language tools 2023-10-17 10:33:25 +07:00
Niels Lange 4a8c446007
Remove superlative sentence 2023-10-17 09:52:28 +07:00
Niels Lange 80aad6da83
Explain how to locate the corresponding language code 2023-10-17 09:49:27 +07:00
Niels Lange 3e9f2c29ac
Display full URL 2023-10-17 09:40:15 +07:00
Niels Lange d03ac90985
Remove developer level doc note (#40746) 2023-10-16 22:14:55 +07:00
Matt Sherman b4474fc633
Doc: Migrate naming conventions (#40781) 2023-10-13 17:56:26 -04:00
Jon Lane b4b107f4f9 Few additional flows 2023-10-13 14:40:59 -07:00
Jon Lane fc1f21b98b Added new flows 2023-10-13 14:35:08 -07:00
Jon Lane 37ededc875 Migration of existing page 2023-10-13 13:37:40 -07:00
Jonathan Lane f0c5e7a22a
Migrate testing instructions doc from wiki (#40720)
* Migrate testing instructions doc from wiki

* Linting fixes

* Linting fixes

* Updated URLs for images

* Add changelog

---------

Co-authored-by: Jon Lane <jon.lane@automattic.com>
2023-10-13 12:58:01 -07:00
Matt Sherman 161219bf73 Fix linting issues 2023-10-13 15:51:27 -04:00
Matt Sherman 0ba4c1d80c CSS naming conventions migration 2023-10-13 15:41:57 -04:00
Matt Sherman 60b77eef28 Naming conventions migration 2023-10-13 15:41:47 -04:00
Niels Lange ac500dcd34
Remove developer doc note 2023-10-13 15:58:10 +07:00
Niels Lange 428ce8ec4f
Save additional *.md liniting error 2023-10-13 13:29:40 +07:00
Niels Lange ab281ac1d2
Fix *.md linting errors 2023-10-13 13:07:51 +07:00
Niels Lange 715b4ccc31
Add docs “Translating WooCommerce” 2023-10-13 12:56:48 +07:00
Corey McKrill a590f8945d
Docs: Add linting rules to style-guide.md (#40647) 2023-10-10 12:12:59 -07:00
Brent MacKinnon 51626a09ec
Update style-guide.md 2023-10-10 13:11:14 -03:00
Brent MacKinnon 88ef351f54
Update style-guide.md 2023-10-10 13:03:17 -03:00
Nathan Silveira dab1457bba
Add 'Declaring compatibility with the product editor' section to Handbook (#40658)
* Add declaring compatibility section

* Improve text
2023-10-10 13:39:44 +00:00
Brent MacKinnon e1f85cbde8
Add linting rules to style-guide.md 2023-10-06 18:05:31 -03:00
Brent MacKinnon ba63366169
Add settings-api.md 2023-10-06 15:06:22 -03:00
Nathan Silveira 793e4a821d
Split product editor blocks into separate directory structures (#40571)
* Create 'generic' and 'product-fields' and separate blocks between the two

* Refactor 'BlockRegistry' to include new directory structure

* Increment README

* Add param documentation

* Add changelogs

* Lint markdown

* Add block directory doc

* Fix jest test

* Update handbook reference
2023-10-04 13:51:25 +00:00
Barry Hughes 798d8d318c
Add docs manifest. (#40507)
This was generated 'manually', however the end goal is to add automations (probably via GH Actions) to regenerate the manifest as and when needed.
2023-10-03 11:33:48 -07:00
barryhughes fb4a48aeb8 Move docs-manifest.json to docs folder. 2023-10-02 09:21:21 -07:00
Nathan Silveira 1903b3a759
Update Product Editor Handbook (#40514)
* Rename title

* Remove common-tasks section as it's currently made redundant by template API documentation

* Create index for reusable blocks doc

* Update reference to the handbook

* Add references to new documentation to the handbook

* Add changelog

* Update README.md
2023-10-02 12:59:35 +00:00
barryhughes 6b7014b239 Manifest needs to be in project root for the paths to work. 2023-09-28 23:05:08 -07:00
barryhughes 5043a1b597 Add docs manifest. 2023-09-28 22:53:32 -07:00
Nathan Silveira 2ed9eadaeb
Create initial version of Product Editor Development Handbook (#40309)
* Add markdown for testing

* Revert "Add markdown for testing"

This reverts commit 63a9fc9f441b97db15bb9ee40c46c38033f2e235.

* Add new folder with block product editor docs

* Iterate over the documentation

* Iterate over documentation

* Add screenshot

* Iterate over doc

* Iterate over documentation

* Iterate over documentation

* Add sample comment

* Rename folder

* Add FAQ and comments

* More changes

* Remove unused README

* Iterate over documentation

* Implement lint changes

* Implement lint changes

* Add changelog

* Remove placeholder readmes

* Remove stale references

* Remove _media folder and add images to developer.woocommerce.com

* Remove placeholder docs

* Improve wording for 'non-standard applications'

* Convert example to new template API hook

* Fix snippet

* Iterate over code review suggestions

* Replace product editor structure image

* Update image reference

* Increment example in common-tasks

* Update add a field next to an existing one sample
2023-09-28 15:40:50 -03:00
Alejandro López Ariza cbe0db4d0f
Add new guide to decide if a PR is high impact. (#40390)
* Add new guide to decide if a PR is high impact.

* Fix markdown errors.
2023-09-25 10:46:37 -07:00
Matt Sherman 7daeb102c5 Fix typo 2023-09-04 16:23:45 -04:00
Brent MacKinnon 90d070739b reverting utilities name change 2023-08-31 13:49:06 -03:00
Brent MacKinnon a32b98b14d adjusting naming and info architecture of docs 2023-08-30 16:37:25 -03:00
Corey McKrill 1640ebaa66
Docs: Add a simple debugging guide and an in-depth doc about using the logger (#39917) 2023-08-29 15:08:14 -07:00
Corey McKrill 7a0eb0f492
Update debugging link for using the logger 2023-08-29 14:05:23 -07:00
Corey McKrill eba89fff61
Docs: Add "Getting started with the REST API" (#39859)
* Docs: Add "Getting started with the REST API"

Migrated from:
* https://github.com/woocommerce/woocommerce/wiki/Getting-started-with-the-REST-API
* https://woocommerce.com/document/woocommerce-rest-api/

* Update broken link

* Remove unnecessary line
2023-08-29 11:23:00 +01:00
Corey McKrill fa850ca038
Completed first draft of debugging and logging docs 2023-08-25 14:08:10 -07:00
Corey McKrill 17fec62a0b
Scaffold new debugging and logging docs 2023-08-24 12:42:38 -07:00
Niels Lange 67d50f551a
Update README.md 2023-08-23 22:45:50 +02:00
Niels Lange a0281cad23
Merge branch 'trunk' into docs/add-or-modify-states 2023-08-23 22:42:39 +02:00
Niels Lange 23246d49b6
Merge branch 'trunk' into docs/add-a-country 2023-08-23 22:07:57 +02:00
Matt Sherman 77e468bb31 Add link to Min/Max Quantities extension 2023-08-23 15:08:30 -04:00
Matt Sherman f7babfbdd2 Add snippet to adjust the quantity input values 2023-08-23 15:08:26 -04:00
Niels Lange 1b85b89bc0
Merge branch 'trunk' into docs/add-or-modify-states 2023-08-23 15:21:19 +02:00
Niels Lange 3687869508
Merge branch 'trunk' into docs/add-a-country 2023-08-23 15:20:54 +02:00
Niels Lange 61da6cb7fa
Merge branch 'trunk' into docs/rename-a-country 2023-08-23 15:19:53 +02:00
Niels Lange 3237e2135f
Merge branch 'trunk' into docs/change-a-currency-symbol 2023-08-23 14:01:20 +02:00
Niels Lange 5a74f2a31b
Add code snippet to add a currency and symbol (#39851) 2023-08-23 13:49:13 +02:00
Niels Lange 4b082cec17
Update docs/snippets/add-or-modify-states.md
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-08-23 12:55:33 +02:00
Niels Lange 6aabbd75d5
Remove developer note 2023-08-23 12:55:06 +02:00
Niels Lange d3413420e1
Remove developer note 2023-08-23 12:53:58 +02:00
Niels Lange e743621c63
Update docs/snippets/add-a-country.md
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-08-23 12:52:19 +02:00
Niels Lange a387e6840a
Update rename-a-country.md 2023-08-23 12:48:03 +02:00
Niels Lange e39e15d202
Update docs/snippets/rename-a-country.md
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-08-23 12:46:29 +02:00
Niels Lange e6eadd9cca
Update docs/snippets/rename-a-country.md
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-08-23 12:45:38 +02:00
Niels Lange 9d93263650
Update change-a-currency-symbol.md 2023-08-23 12:43:24 +02:00
Niels Lange b03db0bee4
Update docs/snippets/change-a-currency-symbol.md
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-08-23 12:40:46 +02:00
Niels Lange 718ab9c74e
Update docs/snippets/change-a-currency-symbol.md
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-08-23 12:37:27 +02:00
Corey McKrill f497e18141
Docs: Add doc for CRUD objects (#39702) 2023-08-22 13:16:55 -07:00
Corey McKrill e6c5d1be3e
Various wording and grammar tweaks 2023-08-22 12:31:14 -07:00
Corey McKrill f6df363683
Docs: Add doc for CRUD objects
Combines the following two older versions of this doc:
* https://github.com/woocommerce/woocommerce/wiki/CRUD-Objects-in-3.0
* https://woocommerce.com/document/developing-using-woocommerce-crud-objects/
2023-08-22 12:31:14 -07:00
Corey McKrill 4ac5f24c7e
Markdown linting fix 2023-08-22 12:15:58 -07:00
Corey McKrill 76174c4f03
Specify language for fenced code blocks 2023-08-22 12:01:15 -07:00
Corey McKrill 4f89b0f307
Docs: Add doc for Data stores
Moves the following Wiki doc into our docs folder and makes some minor
wording and grammatical tweaks:
* https://github.com/woocommerce/woocommerce/wiki/Data-Stores
2023-08-22 11:43:51 -07:00
Brent MacKinnon 072396d07b Create extension-developer-handbook.md 2023-08-22 13:15:03 -03:00
Niels Lange 082a88fa96
Add a currency and symbol 2023-08-22 16:54:20 +02:00
Niels Lange 7803b6e165
Update rename-a-country.md 2023-08-22 16:11:37 +02:00
Niels Lange 769ef9e36a
Update add-or-modify-states.md 2023-08-22 16:10:21 +02:00
Niels Lange 9a81c5e0e8
Update add-a-country.md 2023-08-22 16:09:57 +02:00
Niels Lange b1f3596903
Add a country 2023-08-22 16:04:28 +02:00
Niels Lange 86cc946848
Update add-or-modify-states.md 2023-08-22 16:01:29 +02:00
Niels Lange 3ae66b6803
Update add-or-modify-states.md 2023-08-22 15:58:12 +02:00
Niels Lange d8074c91b1
Add or modify states 2023-08-22 15:51:48 +02:00
Niels Lange 04224dd7e4
Update change-a-currency-symbol.md 2023-08-22 15:48:40 +02:00
Niels Lange 0b48931d11
Change a currency symbol 2023-08-22 14:54:17 +02:00
Niels Lange cd654d5378
Add code snippet to rename a country 2023-08-22 14:36:43 +02:00
Brent MacKinnon 787a7d88f8
Update docs/README.md
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-08-21 16:06:36 -03:00
Brent MacKinnon 6b87c1f7a0
Update docs/README.md
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-08-21 16:06:24 -03:00
Brent MacKinnon 0a3f5744ab Update HPOS.md 2023-08-18 16:05:23 -03:00
Brent MacKinnon 9665a3618e adjusting name of tutorial doc 2023-08-18 16:04:23 -03:00
Brent MacKinnon 453a6ab550 removing QIT for now 2023-08-18 15:56:53 -03:00
Brent MacKinnon 6dec084ab4 Initiating the Docs Information Architecture and committing the first major batch of documents
We've been quietly building a set of documentation in a private repo that we are ready to move over to the public monorepo so that we can continue our initiative to imrpove the documentation experience for Woo developers.
2023-08-18 15:47:07 -03:00
Barry Hughes 1cba486c51
Move 'Adding Actions and Filters' from wiki to docs folder (#39697)
* Move 'Adding Actions and Filters' wiki page to docs folder.

* Apply some recommended readability/grammar tweaks.
2023-08-17 22:17:39 -03:00
Joel Thiessen 144bf08293
Generating the short description on the product editor (#39237)
* [Woo AI] Generate short description after long description is generated.
2023-08-07 14:03:52 +02:00
Darren Ethier d39c0992a5
Adding theme docs structure (#39564)
* Initial theme doc folder structure

* condense to one doc for marketplace-guidelines

Content will be implemented in separate PR.
2023-08-03 11:13:09 -04:00
Niels Lange 4ece72aac4
Merge branch 'trunk' into docs/number-of-related-products-output 2023-07-19 13:25:06 +02:00
Darren Ethier 565c8267de
Add doc for unhooking/removing WooCommerce email notifications snippet. (#39280)
* add doc for unhooking/removing WooCommerce email notifications.

* Update snippet to follow snippet standards.

Co-authored-by: Niels Lange <info@nielslange.de>

* Update docs/snippets/unhook--remove-woocommerce-emails.md

Co-authored-by: Niels Lange <info@nielslange.de>

---------

Co-authored-by: Niels Lange <info@nielslange.de>
2023-07-19 07:19:13 -04:00
Niels Lange 69b2e80428
Correct safe guard function 2023-07-18 16:04:12 +02:00
Niels Lange 96a1e39902
Update docs/snippets/number-of-products-per-row.md
Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2023-07-18 15:57:26 +02:00
Niels Lange 53926dcf64
Update docs/snippets/README.md
Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2023-07-18 15:54:08 +02:00
Niels Lange c48630463f
Add obsolete spaces 2023-07-18 15:49:09 +02:00
Niels Lange ad022e460e
Update docs/snippets/README.md
Co-authored-by: Darren Ethier <darren@roughsmootheng.in>
2023-07-18 15:09:12 +02:00
Niels Lange 0abc8b247e
Add snippet for chaning the number of related products output 2023-07-12 19:56:01 +02:00
Niels Lange ba690a3d19
Link code snippet 2023-07-12 16:30:47 +02:00
Niels Lange 5bb07fd579
Add snippet for adding content above the login/register form (#39177) 2023-07-12 16:18:25 +02:00
Darren Ethier a5f46e9b96
Use sentence case for heading.
Co-authored-by: Niels Lange <info@nielslange.de>
2023-07-12 08:32:47 -04:00
Darren Ethier ba053f791e
Update to follow WooCommerce CS
Co-authored-by: Niels Lange <info@nielslange.de>
2023-07-12 08:32:13 -04:00
Darren Ethier 71b0d32216 add directory for snippet docs and include README.md 2023-07-10 17:23:08 -05:00
Darren Ethier 67540a9f0e Add snippet for adding content above the login/register form 2023-07-10 17:19:58 -05:00
Néstor Soriano ebe8577ad6
Add suggestion from code review
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-06-06 16:33:53 +02:00
Néstor Soriano f5123c2caf
Add suggestion from code review
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-06-06 16:33:44 +02:00
Néstor Soriano 5722634227
Add suggestion from code review
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-06-06 16:33:35 +02:00
Néstor Soriano f1438578e1
Add suggestion from code review
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-06-06 16:33:27 +02:00
Néstor Soriano 52985cb207
Add suggestion from code review
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-06-06 16:33:18 +02:00
Néstor Soriano bb7eca8da1
Add suggestion from code review
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-06-06 16:33:09 +02:00
Néstor Soriano 50b7554f7a
Add suggestion from code review
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-06-06 16:33:01 +02:00
Néstor Soriano 66b9f715bc
Add suggestion from code review
Co-authored-by: Barry Hughes <3594411+barryhughes@users.noreply.github.com>
2023-06-06 16:32:53 +02:00
Nestor Soriano 6a9ce0287a
Add a docs directory with a README and a HPOS.md file
The README contains a list of other existing README files.
2023-03-30 11:45:00 +02:00