Commit Graph

312 Commits

Author SHA1 Message Date
Brent MacKinnon 94cacbdf56
Update category desc (#42978)
* reorganizing documents for better discoverability

* adding and adjusting category descriptions for docs site

---------

Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
2024-01-08 15:51:24 -05:00
Jacklyn Biggin aa0f1b14b3
Remove table of contents from docs (#42874) 2024-01-08 14:57:15 -05:00
Jacklyn Biggin 38d2bd52ac
Remove newlines at the start of docs (#42843) 2024-01-08 14:50:49 -05:00
Ron Rennick 60b3aa8ed8
add support for custom document and category titles (#43340)
* add support for custom document and category titles

* remove the s in the source file instead of the manifest

---------

Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2024-01-05 18:20:31 -05:00
Brent MacKinnon b4254234d7
post-title updates for theme and ux docs (#43023)
* post-title updates for theme and ux docs

* Update thumbnail-image-regeneration.md
2024-01-05 13:03:59 -05:00
Brent MacKinnon a471ec2105
Update developer-tools.md (#43065) 2024-01-05 12:33:45 -05:00
Brent MacKinnon e43cfede32
Creating: payments design guidelines (#43330)
* Create payments-design-guidelines.md

* Update payments-design-guidelines.md

* Update payments-design-guidelines.md

* Update payments-design-guidelines.md

* Update payments-design-guidelines.md

* Update payments-design-guidelines.md

* Update payments-design-guidelines.md
2024-01-05 12:33:11 -05:00
Brent MacKinnon 6099718727
new ux guidelines: navigation, testing, settings (#43329)
* new ux guidelines: navigation, testing, settings

* Update navigation.md

* Update navigation.md
2024-01-05 11:53:54 -05:00
Brent MacKinnon 006bdc20bb
Delete marketplace-guidelines.md (#41811) 2024-01-05 11:52:22 -05:00
Brent MacKinnon b36bacf531
migrating images out of docs folder (#42851)
* migrating images out of docs folder

Migrating  images from '_media' folders to developer.woo.com/docs media folder and removing media folders and image files from docs folder.

* Delete 73 results - 16 files.md
2024-01-05 11:41:03 -05:00
Brent MacKinnon 10f6109982
removing developer notices (#43024)
removing two developer notices and adjusting the length of a long post title.
2024-01-05 11:39:37 -05:00
Ron Rennick ca5813d4f7
update external relative links to full URLs (#43231)
* update external relative links to full URLs

* update the docs manifest

* include /packages relative links

* add blob/trunk for direct access

---------

Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2024-01-04 17:07:57 -04:00
Ron Rennick 64a51caa06
replace forward tick with ' in docs folder (#42799)
* replace forward tick with ' in docs folder

* replace encoded bcktick with single quote in docs folder

---------

Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2024-01-02 16:59:26 -04:00
Néstor Soriano a8b0f88bad
Introduce the transient files engine (#42877)
Co-authored-by: Corey McKrill <916023+coreymckrill@users.noreply.github.com>
2023-12-22 08:44:18 +01:00
Ron Rennick ce7572c8c5
replace encoded dashes with hyphen in docs (#42845)
Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2023-12-18 10:03:16 -04:00
Ron Rennick c088ddec5d
exclude placeholder docs from docs manifest (#42876)
* exclude placeholder docs from docs manifest

* remove marketplace-guidelines from manifestignore

---------

Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2023-12-18 10:02:24 -04:00
Brent MacKinnon b9cee5ca8c
Create image-sizes.md (#41722)
* Create image-sizes.md

* adding thumbnail-image-regeneration.md

migrating thumbnail doc from wiki (https://github.com/woocommerce/woocommerce/wiki/Thumbnail-Image-Regeneration-in-3.3) so that the internal link can be updated in our image sizing document.

* Update image-sizes.md

* Update thumbnail-image-regeneration.md

* Update thumbnail-image-regeneration.md
2023-12-18 12:50:06 +00:00
Ron Rennick 7c2aff354b
add default manifest ignore (#41969) 2023-12-11 13:59:30 -04:00
Christopher Allford d443e92f23 Renamed Shortcode Assets "Classic" 2023-12-09 15:37:13 -08:00
Christopher Allford fa011a431b Removed Unnecessary `run` From `pnpm` 2023-12-09 14:36:22 -08:00
Christopher Allford 1e4d55b36a Updated Documentation 2023-12-09 14:30:29 -08:00
Ron Rennick 2d5f3e2c2e update docs manifest, add default manifest ignore 2023-12-08 16:47:24 -04:00
Ron Rennick eb763901fa add manifestignore support to generate docs manifest tool 2023-12-08 12:06:55 -04:00
Ron Rennick 2fdb240b11 update docs manifest 2023-12-06 12:04:31 -04:00
Ron Rennick e7b1af8a06 improve category properties, s/readme/README file names 2023-11-30 16:32:52 -04:00
Brent MacKinnon b080f7ed7b
Update configuring-caching-plugins.md 2023-11-30 15:08:18 -04:00
Brent MacKinnon 10670ac029
Update readme.md 2023-11-30 15:07:11 -04:00
Brent MacKinnon d2c63b7f38
Update readme.md 2023-11-30 15:06:15 -04:00
Ron Rennick f5be957347 revert code sample substitutions 2023-11-29 15:40:54 -04:00
Ron Rennick ea2c2a0aac replace colons in docs titles 2023-11-29 15:26:22 -04:00
Ron Rennick 52dcaf91d7 add graymatter to docs 2023-11-29 14:48:05 -04:00
Leif Singer 2ead36530d
Create classic-theme-developer-handbook.md (#41721) 2023-11-29 14:51:41 +01:00
Leif Singer e6777adad2
Create set-up-a-child-theme.md (#41719) 2023-11-29 14:24:58 +01:00
Leif Singer b6b1f61807
remove-redundant--ref-code-folder (#41727) 2023-11-29 13:47:03 +01:00
Leif Singer 17fd6aa280
Create configuring-caching-plugins.md (#41591) 2023-11-29 13:45:40 +01:00
Leif Singer 2aadc5d134
Create gdpr-compliance.md (#41589) 2023-11-29 13:44:35 +01:00
Leif Singer 75e3cc3185 fix spelling, grammar, etc. 2023-11-29 13:43:21 +01:00
Leif Singer c40623349b fix / repair / remove broken and / or outdated links 2023-11-29 13:01:07 +01:00
Leif Singer 06d5f021f8 https instead of http; woo.com instead of woocommerce.com 2023-11-29 12:53:23 +01:00
Leif Singer e9d5ecd76a missed a formatting tweak 2023-11-29 12:50:59 +01:00
Leif Singer bc6fe4242d code formatting tweaks 2023-11-29 12:49:52 +01:00
Leif Singer 5da7ddea06 unescape escaped asterisks, since they're all in code blocks this should be fine 2023-11-29 12:48:12 +01:00
Leif Singer 2142f199bd tweak a few links 2023-11-29 12:00:43 +01:00
Leif Singer c4424e8325 appease the markdown linter 2023-11-29 11:48:33 +01:00
Brent MacKinnon 388ec85f06 remove-redundant--ref-code-folder 2023-11-29 11:46:55 +01:00
Ron Rennick 759d903d92
use consistent capitalization in docs titles (#41717) 2023-11-28 11:19:43 -04:00
Brent MacKinnon 6e039e8578 Update classic-theme-developer-handbook.md 2023-11-28 10:56:52 -04:00
Brent MacKinnon ced11e9730
Rename README.md to translating-woocommerce.md 2023-11-27 17:12:39 -04:00
Brent MacKinnon 8d2489de29 Update classic-theme-developer-handbook.md 2023-11-27 16:53:14 -04:00
Brent MacKinnon 1a99ef2b8a Create classic-theme-developer-handbook.md 2023-11-27 16:25:00 -04:00
Brent MacKinnon a456a9f24f Create set-up-a-child-theme.md 2023-11-27 16:01:57 -04:00
Ron Rennick eec31465a0 use consistent capitalization in docs titles 2023-11-27 15:52:33 -04:00
Brent MacKinnon c10f1100b3
Add plugin API callback documentation (#41588)
* Create woocommerce-plugin-api-callback.md

* Update woocommerce-plugin-api-callback.md

* Update docs/extension-development/woocommerce-plugin-api-callback.md

Co-authored-by: Leif Singer <leif@automattic.com>

* Update docs/extension-development/woocommerce-plugin-api-callback.md

Co-authored-by: Leif Singer <leif@automattic.com>

* Update docs/extension-development/woocommerce-plugin-api-callback.md

Co-authored-by: Leif Singer <leif@automattic.com>

* Update woocommerce-plugin-api-callback.md

---------

Co-authored-by: Leif Singer <leif@automattic.com>
2023-11-24 10:03:16 +01:00
nigeljamesstevenson 2fc7057e16
Update deciding-pr-high-impact.md 2023-11-23 11:30:20 +00:00
Leif Singer f93f2ad3dd
Create Fixing Outdated WooCommerce Templates (#40759) 2023-11-21 12:42:00 +01:00
Leif Singer 39a1164d98
Update / tweak a few more links in docs and comments (#41598) 2023-11-21 12:38:09 +01:00
Leif Singer 233e5c01b7 rename the file to adhere to naming conventions in the docs folder 2023-11-21 10:28:31 +01:00
Leif Singer 009779c462 add the image back in 2023-11-21 10:27:45 +01:00
Leif Singer 42f862c630 add back in links and tweak wording 2023-11-21 10:27:34 +01:00
Rania Lang bc1b9cd88b Create Fixing Outdated WooCommerce Templates 2023-11-21 10:16:48 +01:00
Brent MacKinnon 728389cd39 Update configuring-caching-plugins.md 2023-11-20 13:16:47 -04:00
Brent MacKinnon d8ec0f68e0 Create configuring-caching-plugins.md 2023-11-20 13:13:47 -04:00
Brent MacKinnon a54c09d4bd Create gdpr-compliance.md 2023-11-20 13:00:39 -04:00
Matt Sherman f33352591f Slight rewording of extensibility intro 2023-11-17 10:23:26 -05:00
Matt Sherman f5bd33e083 Correct changelog date 2023-11-17 10:21:59 -05:00
Matt Sherman 7c44e6d670 Updates based on latest guidelines draft 2023-11-16 21:02:03 -05:00
Nathan Silveira 6d10a7e9ee Update product-editor-extensibility-guidelines.md 2023-11-16 19:01:04 -05:00
Nathan Schneider d4da4898b9 Update extensibility guidelines 2023-11-16 19:01:04 -05:00
Nathan Schneider d512e6efbb Increment doc based on feedback 2023-11-16 19:01:04 -05:00
Nathan Schneider 4a97065da2 Fix markdown lint issues 2023-11-16 19:01:04 -05:00
Nathan Schneider e3f350cffc Add Product Editor Extensibility Guidelines 2023-11-16 19:01:04 -05:00
Leif Singer 5944fdcdff replace developer.woocommerce.com with developer.woo.com 2023-11-10 16:09:27 +01:00
Leif Singer 1e1fec80aa capitalize Woo.com when used in a sentence 2023-11-10 15:49:08 +01:00
Leif Singer 5c0f155858 always use https when possible
Co-authored-by: Denis Dvali <denis.dvali@automattic.com>
2023-11-10 15:49:08 +01:00
Leif Singer 808a0fc54f update references to woocommerce.com to now reference woo.com 2023-11-10 15:49:08 +01:00
Leif Singer 47accc8c4f appease the linter 2023-11-07 14:20:48 +01:00
Leif Singer ecb746e8f1 remove google url redirects from urls 2023-11-07 14:20:48 +01:00
Leif Singer ac36a464db appease the linter 2023-11-06 14:20:05 +01:00
Leif Singer 7394e8344f update woocommerce.com email addresses to woo.com 2023-11-06 14:06:54 +01:00
Matt Sherman f22839dfd4 Add link to template lifecycle 2023-10-24 18:33:35 -04:00
Matt Sherman 4723d53884 Initial version of block template lifecycle doc 2023-10-24 18:33:16 -04:00
Kader Ibrahim S 82b90d07ec
Adds documentation for WooCommerce endpoints (#40773)
* Adds WooCommerce Endpoints documentation

* Removes images from `woocommerce.com` domain.

* Embed code directly into markdown instead of using gists.

* Adds images to the document.

* Adds changelog file

* Move the document to the right folder.

* Fixes markdown lint issues
2023-10-24 11:04:38 +02:00
Kader Ibrahim S 7aea11a7d0
Adds documentation for Checkout Fields customisations using actions and filters (#40775)
* Initial commit from HTML to Markdown.

* Migrates checkout actions and filters document.

* Fixes linting errors
2023-10-23 23:28:09 +02:00
Leif Singer 492a41890c
Docs: add wc cli overview (#40770)
* add wc-cli/overview.md

* tweaks to content

* appease the linter
2023-10-23 23:14:51 +02:00
Leif Singer 2219c5686e
Docs: add wc cli commands (#40774)
* add wc-cli/commands.md

* convert HTML to markdown, clean up, and appease the linter
2023-10-23 23:03:16 +02:00
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