Developer Examples

27 views
Skip to first unread message

David A. Harding

unread,
Jun 2, 2014, 1:36:32 PM6/2/14
to bitcoin-do...@googlegroups.com
As discussed previously[1], the developer docs are intended to have three
main pages: the Developer Guide, the Developer Reference, and another
page we provisionally called the Developer Cookbook (because it would be
similar to the O'Reilly "[Programming Language] Cookbook"-style books.

[1] https://groups.google.com/d/msg/bitcoin-documentation/YHc-5L7jY74/I-UUPEIgqO4J

I've added this page using the name Developer Examples. The new page
features a newly-written set of example transactions with detailed
explanations, which is something that's been TODO'd for a couple months
now. It also features the extended BIP70 example from the Guide. A
preview is available here:

http://dg0.dtrt.org/en/developer-examples

The extended BIP70 example from the Guide has been removed and replaced with
an overview-level description of the Payment Protocol:

http://dg0.dtrt.org/en/developer-guide#payment-protocol

Now that we have three pages, I also gave each of the full pages their
own icon on the portal page:

http://dg0.dtrt.org/en/developer-documentation

There are also some other minor changes I'll explain in the Pull
Request (PR). However, before I PR, I want to make sure we're all in
agreement on the necessity of this separate page and the name given to
it. If you have any problems, please reply to this email.

The actual changes are here:

https://github.com/harding/bitcoin.org/tree/generatingtxes

Thanks,

-Dave
--
David A. Harding

Saïvann Carignan

unread,
Jun 2, 2014, 11:09:33 PM6/2/14
to bitcoin-do...@googlegroups.com
The new name sounds perfect to me

I didn't read it all yet, but what I've seen looked great!

s/The raw transaction RPCs/The raw transaction RPC ?

s/Coinjoin/CoinJoin ?

Payment Protocol should probably not be under "QR Code Error Correction"
(it could use h3 instead of h4)?

Saīvann

David A. Harding

unread,
Jun 3, 2014, 1:06:32 AM6/3/14
to bitcoin-do...@googlegroups.com
On Mon, Jun 02, 2014 at 11:09:24PM -0400, Saīvann Carignan wrote:
> The new name sounds perfect to me

Thanks!

> s/The raw transaction RPCs/The raw transaction RPC ?

This is a general reference to the RPCs which create or operate on raw
transactions, so the plural form ("Remote Procedure Calls") is correct.

> s/Coinjoin/CoinJoin ?

Good catch! I forgot we used camel case before.

> Payment Protocol should probably not be under "QR Code Error Correction"
> (it could use h3 instead of h4)?

Whoops! Glad you caught that.

I'll make the changes tomorrow. I also plan to submit the PR tomorrow.

Thanks!,
Reply all
Reply to author
Forward
0 new messages