Rewrite payments overview documentation #2613
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benjaminwil
force-pushed
the
rewrite_payments_overview_documentation
branch
2 times, most recently
from
45afc66 to
82ee02f
Compare
This commit reduces the barrier to entry for developers getting started with Solidus's payments system. It does this by identifying five essential parts of the payments system and explaining how they fit together to make payments work. I realize that there are other parts of the system that are not covered yet. I can imagine additional articles about payments being linked to from this overview in future pull requests.
benjaminwil
force-pushed
the
rewrite_payments_overview_documentation
branch
from
82ee02f to
4582d23
Compare
gmacdougall
approved these changes
Apr 17, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR reduces the barrier to entry for developers getting started with Solidus's payments system.
It does this by identifying five essential parts of the payments system and explaining how they fit together to make payments work.
I realize that there are other parts of the system that are not covered yet. I can imagine additional articles about payments being linked to from this overview in future pull requests.
I also realize that this PR removes description of the
Spree::Paymentstate machine. I promise this is coming back in another pull request this week.This is part a larger project to improve Solidus's documentation. See this gist with the high-level table of contents. Where and how this documentation will exist is still up for discussion.