woocommerce / woocommerce

A customizable, open-source ecommerce platform built on WordPress. Build any commerce solution you can imagine.
https://woocommerce.com
9.43k stars 10.77k forks source link

[DOC-BUG] Mention identifier of available field locations #52823

Open nielslange opened 2 weeks ago

nielslange commented 2 weeks ago

Link to the Page/Section

Provide a link to the specific page or section that you're referring to.

https://developer.woocommerce.com/docs/cart-and-checkout-additional-checkout-fields/#0-available-field-locations

Description of the Suggestion

Describe the changes you suggest to improve or correct the documentation. Be specific about any errors or areas of confusion you've identified.

Currently, the section refers to the following locations:

At this stage, it's unclear what identifier these locations have. I suggest replacing this list with the following table:

Title Identifier
Contact information contact
Addresses (Shipping and Billing) address
Order information order

Additionally, including snippets and screenshots for each field location would further help developers visualize the changes and understand where their custom fields will appear.

Reason for the Suggestion

Why do you believe this change will make the documentation clearer or more accurate?

Currently, the section Available field locations only tells the name of the available locations, but it does not mention the corresponding identifier. While the section Using the API lists the available locations, it's easy to miss this part.

senadir commented 2 weeks ago

Make sense!