Skip to content

Restructured Payments chapter. - #625

Merged
sbddesign merged 10 commits into
BitcoinDesign:masterfrom
Bosch-0:payments_restructure
Feb 3, 2022
Merged

Restructured Payments chapter.#625
sbddesign merged 10 commits into
BitcoinDesign:masterfrom
Bosch-0:payments_restructure

Conversation

@Bosch-0

@Bosch-0Bosch-0 commented Jan 19, 2022

Copy link
Copy Markdown
Collaborator

Closes#596

Re structured the payments pages based on the above issue. I found the payment requests formats page to make more sense as a sub-page for the requesting bitcoin page, what do you think @GBKS?

  1. This is requesting flows.
  2. This is the types of requests that can be used.
  3. This is how to send to those formats.

I found this order flowed smoother.

Preview

@GBKSGBKS added Copy Task is about improving text. Enhancement New feature or request labels Jan 19, 2022
@GBKS

GBKS commented Jan 19, 2022

Copy link
Copy Markdown
Contributor

Thanks for addressing this.

Do you think the Payment request formats page is necessary for readers to understand the Requesting bitcoin and Sending bitcoin pages? If not, then it's complementary and I think it could be well places towards the end of the section, after `Transaction overview´.

Should Transaction overview´ maybe be Transaction lifecycle´?

Make sure add redirect_from meta info to pages in which you change the permalink. I think there can be multiple entries if a page is moved multiple times.

I could also see us create a Receiving bitcoin page and split out that content to give it the space it needs so we can cover it in detail (different PR though).

@Bosch-0

Copy link
Copy Markdown
CollaboratorAuthor

Do you think the Payment request formats page is necessary for readers to understand the Requesting bitcoin and Sending bitcoin pages?

I think it adds context to both pages and makes it clearer what kind of things are possible, I don't think you need to understand them all to grasp those pages but it gives a clearer picture.

Should Transaction overview´ maybe be Transaction lifecycle´?

I prefer overview as it essentially covers more than one lifecycle (on-chain + Lightning)

I could also see us create a Receiving bitcoin page and split out that content to give it the space it needs so we can cover it in detail (different PR though).

Yeah agree, we may want to go more in-depth with LSP stuff here to as that is where they come in to play.

Comment threadguide/glossary/coin-selection.md
Comment threadguide/payments/payment-request-formats.md

@GBKSGBKS left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great now. Just had two nitpicks about adding redirects for pages where the URL changed.

@sbddesignsbddesign left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looking good. I don't think I closely followed previous discussions about re-organizing the payments section, but I have no strong opinions about it. The new structure seems reasonable to me.

I left several grammatical, stylistic, and typographical edits. As usual, some of them are grammatically necessary and some are just my opinion on writing style.


Illustration source

-

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit -- did you intend to include an illustration source file here? All I see is the surrounding comment tag.

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just got in a habit of adding that there, not sure where the file is for that header @GBKS did you do this one?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@johnsBeharry did that one.

Comment threadguide/payments/introduction.md Outdated
Comment threadguide/payments/payment-request-formats.md Outdated
Comment threadguide/payments/request.md Outdated
Comment threadguide/payments/send.md Outdated
Comment threadguide/payments/transactions.md Outdated
Comment threadguide/payments/units-and-symbols.md Outdated
Comment threadguide/payments/units-and-symbols.md Outdated
Bosch-0and others added 9 commits February 3, 2022 10:44
Co-authored-by: Stephen DeLorme <stephen@stephendelorme.com>
Co-authored-by: Stephen DeLorme <stephen@stephendelorme.com>
Co-authored-by: Stephen DeLorme <stephen@stephendelorme.com>
Co-authored-by: Stephen DeLorme <stephen@stephendelorme.com>
Co-authored-by: Stephen DeLorme <stephen@stephendelorme.com>
Co-authored-by: Stephen DeLorme <stephen@stephendelorme.com>
Co-authored-by: Stephen DeLorme <stephen@stephendelorme.com>
@Bosch-0
Bosch-0 requested review from GBKS and sbddesignFebruary 3, 2022 05:25
GBKS
GBKS approved these changes Feb 3, 2022

@GBKSGBKS left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK. Ready to go. Thank you for working through this.

@pavlenex

Copy link
Copy Markdown
Contributor

@sbddesign Requires your approval so we can merge it in.

@sbddesignsbddesign left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the edits, LGTM! 💯

@sbddesign
sbddesign merged commit 9408a10 into BitcoinDesign:masterFeb 3, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CopyTask is about improving text.EnhancementNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Reorder pages in the Payments section

4 participants

@Bosch-0@GBKS@pavlenex@sbddesign