craftcms / craftcms/docs

Improve “Payment Gateway Types”

Open
#467 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

I don't have a suggestion for https://craftcms.com/docs/commerce/4.x/extend/payment-gateway-types.html

  • Add workflow charts
  • Add code examples
  • Do actually explain what a Gateway Type is - you only say that we can add our own and reference the Dummy Gateway
  • Explain when, where and why hashes/reference and other numbers get generated
  • Make it clear which components (controllers, models, services etc..) are in play and which ones are interchangeable (all of course, but which ones make sense to alter and when)

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

Start with the Payment Gateway Types page at https://craftcms.com/docs/commerce/4.x/extend/payment-gateway-types.html and its Dummy Gateway reference. Audit the current explanation, then define the workflow charts, code examples, identifier-generation details, and component guidance needed for the page to explain gateway types and extension points clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.