Commit Graph

297 Commits

Author SHA1 Message Date
Chi-Hsuan Huang 6832a4b249
Update onboarding task documentation & add back `example` command (#44026) 2024-01-30 12:05:46 +08:00
Brent MacKinnon 7b5519e543
Update .manifestignore (#44091) 2024-01-25 16:01:14 -05:00
Paweł Nguyen 8b006bd40e
Fix a link typo in adding-a-section-to-a-settings-tab.md (#44038) 2024-01-25 17:56:53 -03:00
Brent MacKinnon 58088ed448
Simplify and atomize the Extension Developer Handbook (#43832)
* Simplifying and atomizing extension-developer-handbook

* Update logging.md

* Update extension-development-best-practices.md

* Update docs-manifest.json

* Revert "fixing a few broken image links"

This reverts commit 058c1fcd05993380efb0d6703f13192d1aad2a68.

* Update extension-development-best-practices.md

* Update docs-manifest file

* Adds most recent version of manifest after command run

* Removes old docs-manifest

* Renames new manifest

---------

Co-authored-by: Shani Banerjee <shanibanerjee@Shanis-MBP.lan>
2024-01-24 19:54:10 -05:00
Brent MacKinnon 664140f134
Adjusting relative links in docs folder to avoid 404s on docs site (#44044)
* Adjusting relative links in docs folder to avoid 404s on docs site

Adjusting relative links in docs folder to avoid 404s on docs site

* Update docs-manifest.json

* Update docs manifest to reflect current trunk

* Fix invalid links

* Update manifest

---------

Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
2024-01-24 17:00:12 -05:00
Shani bf11df5e46
Atomizing and Improving WC-CLI documentation - Fixed PR (#44016)
* Atomizing and Improving WC-CLI documentation

* Adds new docs manifest, deletes previous manifest, renames new manifest

* Fix linting errors

* Fix additional linting errors

* Fix remaining linting issue

---------

Co-authored-by: Brent MacKinnon <brent.mackinnon@a8c.com>
Co-authored-by: Shani Banerjee <shanibanerjee@Shanis-MBP.lan>
Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
2024-01-24 16:18:11 -05:00
Ron Rennick bbed678d13
add manifest check to pr markdown lint workflow (#43534)
* add manifest check to pr markdown lint workflow

* add json validation, storybook exception

* restore post tags to manifest

* add is-valid-json.js

---------

Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2024-01-24 12:39:22 -04:00
Ron Rennick 32104860b5
correct the command for generating the docs manifest (#43831)
Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2024-01-23 13:36:49 -05:00
Jacklyn Biggin 4eb8626621
Docs: Update go-vip.net links/images to developer.woo.com (#43863)
* Update go-vip.net links/images to developer.woo.com

* Update go-vip.net links (with correct /)

* Force git to work

* Flx links

* fixing-image-links

---------

Co-authored-by: Brent MacKinnon <brent.mackinnon@a8c.com>
2024-01-22 13:13:17 -05:00
Brent MacKinnon e995ee387d
Atomizing and tagging Endpoint documentation (#43833)
* Atomizing and taggig Endpoint documentation

* Create manifest.json

* regenerating manifest

* fix manifest

---------

Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
2024-01-19 16:56:19 -05:00
Brent MacKinnon 73f50e61b3
Removing links from headings in docs where warranted. (#43824)
* Removing links from headings in docs where warranted.

* Fix readme capitalizion

---------

Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
2024-01-19 16:43:59 -05:00
Jacklyn Biggin c0198cc599
Update docs manifest regeneration instructions (#43802) 2024-01-18 18:20:40 -05:00
Ron Rennick 45dc57f814
improve consistency on docs code blocks (#43758)
Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2024-01-18 10:38:23 -04:00
Brent MacKinnon 5f6e18e922
Removing notices that are no-longer-relevant (#43766)
* Removing notices that are no-longer-relevant

Removing "WIP" and "developer-level" notices, and fixing a few titles

* add updated docs manifest

---------

Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
2024-01-17 18:17:14 -05:00
Brent MacKinnon 3765649a7d
Update payments-ux-guidelines README.md to swap a character that was encoding improperly (#43764)
Update README.md
2024-01-17 17:41:47 -05:00
Jacklyn Biggin 097f72774a
Update docs manifest for Product Editor Guidelines (#43752)
update docs manfiest
2024-01-17 12:47:05 -05:00
Jacklyn Biggin a786b57cd6
Fix metadata for product editor guidelines category (#43751)
fix metadata for product editor guidelines
2024-01-17 12:16:21 -05:00
Jacklyn Biggin 658518b447
Update docs manifest (#43718)
Update manifest + fix duplicated key
2024-01-17 09:36:31 -04:00
Matt Sherman 824dc6be51
Remove BlockTemplateRegistry (#43589) 2024-01-17 07:12:12 -05:00
Jacklyn Biggin 42a90a317f
Rework UX guidelines to be in distinct folders and files (#43543)
* Rework UX guidelines to be in distinct folders and files

* Rename general guidelines to extensions guidelines

* Move contents of user-experience-guidelines.md into readme

* Rename "user experience guidelines" to "extension guidelines"

* Moved payments blurb from onboarding to readme

* Move product editor guidelines into a ux-guidelines folder

* Remove extra quote on payment guidelines image

* Add notice at top of theme customization page

* Fix linting issues
2024-01-16 16:04:53 -05:00
Brent MacKinnon 02b02ee23d
Further adjustment of post titles, menu titles, and tags (#43685)
* Adjusting post_titles, menu_titles, and tags for docs folder

Adjusting the post_titles, menu_titles, and tags for  document files in the docs folder

* Update removing-product-product-category-or-shop-from-the-url.md

* Update classic-theme-developer-handbook.md

* further adjustments and casing

* Move HPOS/CLI contents into README

---------

Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
2024-01-16 14:29:00 -05:00
Ron Rennick 8a7ffac49b
add post tags support to docs manifest generator (#43575)
* Add tags to some readme files

* add post tags support

---------

Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2024-01-16 12:54:37 -05:00
Jacklyn Biggin 1d0a00741a
Fix all remaining docs encoding issues (#43683)
* Fix data management readme

* fix localization/translation category typo

* Fix remaining encoding issues

* update docs manifest
2024-01-15 21:52:17 -05:00
Jacklyn Biggin 9aafe545c5
Remove manually found unicode characters in docs (#43677)
* Remove manually found unicode characters

Non-regular spaces, quotes, dashes

* Fix linting

* fix more linting issues

* Fix more linting

* fix enable-hpos.md linting

* Update docs manifest
2024-01-15 19:42:12 -05:00
Jacklyn Biggin f29ad09154
Rename "Contributing" category + tag files (#43675)
* Tag contributor docs

* Update contributing category name

* Update manifest

* Fix unicode issues
2024-01-15 19:09:52 -05:00
Jacklyn Biggin 303760ba5b
Create docs contributor guide category + content (#43668)
* Create technical docs contribution guide

* Move style guide into docs contribution folder

* fix manifest instructions

* add docs manifest

* Fix linting issues

* fix more linting

* temp. remove inline links to fix linting
2024-01-15 15:07:04 -05:00
Matt Sherman b4a39483da
Doc: Migrate "Working with WooCommerce Admin Pages" (#40007)
* Initial migration

* Add additional links to code reference

* Fix lint indentation issue

* Add nav_args['parentPath'] documentation

* Minor code style fix (spacing)

* Update add_extension_register_page example to adhere to guidelines

* Update woocommerce_admin_pages_list filter example to conform to guidelines

* Update parentPath doc to make it clear that it is part of the JS config, not the PHP config
2024-01-15 09:04:39 -05:00
Brent MacKinnon f576e543ba
Removing duplicated post titles from User experience docs. (#43472)
* Removing duplicated post titles from User experience docs.

* further adjustments to UX docs
2024-01-10 12:32:17 -05:00
Jorge A. Torres 801cd03fa9
Make “Customising Checkout Fields” guide CRUD compatible (#43446)
* Make “Customising Checkout Fields” guide CRUD compatible

* Update docs manifest
2024-01-10 16:58:55 +00:00
Jacklyn Biggin 2113b3b5ae
Update docs manifest (#43434) 2024-01-10 10:07:07 -05:00
Brent MacKinnon 78a17a25bd
Adding menu_title to user-experience docs (#43429)
* adding menu titles to docs

* Update payments-design-guidelines.md

* Update task-list-and-inbox.md

* More adjustments

* Update onboarding.md
2024-01-09 12:54:13 -05:00
Jacklyn Biggin 1ef98dc7f3
Remove leftover merge issue in onboarding.md (#43423) 2024-01-09 12:11:19 -05:00
Ron Rennick 0ec42d2cb6
add linting configuration for docs folder (#43376)
* add linting configuration for docs folder

* fix markdown glob in repo lint

---------

Co-authored-by: Ron Rennick <ronald.rennick@automattic.com>
2024-01-09 10:09:59 -04:00
Brent MacKinnon 107bf38f58
reorganizing documents for better discoverability (#42881)
Co-authored-by: Jacklyn Biggin <hi@jacklyn.dev>
2024-01-08 16:41:47 -05:00
Miguel Pérez Pellicer 0424640b0c
Migrate documentation for Webhooks (#40749)
* Migrate documentation for Webhooks

* Markdown lint

* Move webhooks
2024-01-08 16:12:32 -05:00
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