craftcms / craftcms/docs

[Content]: Improve explanation surrounding order addresses and users' address book

Open
#509 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

💳 Commerce
Dominant language
JavaScript
Stars
42
Forks
160
Avg merge
3h 9m
Merged PRs (30d)
4

Description

Product

Commerce

Description

Along with a fix in https://github.com/craftcms/commerce/pull/3182 we could do with improving the documentation surrounding addresses and how they work with orders and users' address books.

Giving technical information on how addressing and orders works is vital, we could also look to give a more example based set of documentation. "Adding a guest address", "Adding an address from the address book", "Updating an address for a guest/logged in user"

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the current Craft Commerce documentation about addresses, orders, and users, then read the related behavior in PR #3182. Update the relevant documentation with technical explanations and examples for guest addresses, address-book addresses, and address updates for guest or logged-in users; done when these workflows are clearly covered.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.