Commit graph

22 commits

Author SHA1 Message Date
David A. Harding
2312aa10fd
Dev Docs: Merge RPC and RPC Intro
This commit merges the RPC introduction section (h4), "JSON-RPC &
bitcoin-cli" into the currently-empty RPC section (h3).  To do this, it
splits the contents of the file `_includes/ref_core_rpc_intro.md` into
the new files `_includes/ref/bitcoin-core/api-intro.md` and
`_includes/ref/bitcoin-core/rpcs/intro.md`
2015-01-27 18:40:20 -05:00
David A. Harding
5f532c59da
Dev Docs: Add REST Documentation
* Uses same basic format as JSON-RPC documentation.

Closes #715
2015-01-26 11:29:07 -05:00
David A. Harding
b8abfb2dcd
Dev Docs: Add 114 Pages Of New/Rewritten RPC Docs
* All previously-documented RPCs have had their text completely
  rewritten.

* All new RPCs and changed RPCs in Bitcoin Core 0.10.0 have been
  documented, except for hidden RPCs.

* A new RPC "Quick Reference" section has been added to make finding the
  right RPC easier.

* A "See Also" subsection has been added to the end of every RPC
  pointing to other relevant information.

* All previous examples in the RPC section have been re-run and updated
  as necessary.

* Syntax highlighting has been added wherever possible.

* Hash byte order has been specified as RPC byte order everywhere it's
  used in RPCs.
2014-12-24 18:46:03 -05:00
David A. Harding
8f0a80a939 Dev Docs: "Not A Specification"
Make explicit that the docs are not a specification and never will be.
2014-12-16 07:40:01 -05:00
David A. Harding
53d4a6eebe
Dev Docs: Move Manual Sourcefile Lines To Auto Helper (thanks saivann!) 2014-12-14 08:12:12 -05:00
David A. Harding
f368d38e04
Dev Docs: Add "Edit|History|Report Issue|Discuss" Links To Subheads 2014-12-13 17:35:21 -05:00
Saivann
2a139a51a1 Set license files and headers for bitcoin.org's content 2014-11-21 19:09:12 -05:00
Saivann
224f67f9ec Fix broken links in devel-docs (thanks @icook) 2014-11-17 12:31:39 -05:00
Saivann
7a6484fc21 Add contextual link to source file on GitHub in devel-doc (thanks @icook @harding) 2014-11-16 23:32:58 -05:00
David A. Harding
1634212dd5
Dev Docs: Add P2P Messages That Request Or Reply With Data
Adds to the devel reference page detailed documentation on the following
messages: block, getblocks, getdata, getheaders, headers, inv, mempool,
merkleblock, notfound, and tx.

Adds to the devel examples page an example of requesting and parsing a
merkleblock message.

Adds to the devel docs overview pages links to the above two new
P2P sections.

Tweaks the autocrossref plugin ignore pattern to not crossref in the
middle of a GIF image name; this allows the inclusion of animated GIFs.
2014-11-12 12:39:36 -05:00
David A. Harding
e65d86de21
Mention Bitcoin's RPC Hash Byte Order
* Add a short subsection about the different byte orders used with
  hashes in Bitcoin Core and other software.

* Re-word some text in other sections to mention the byte order
  differences

This commit created based on comments from @SergioDemianLerner (thanks!)
2014-10-23 14:53:52 -04:00
Saivann
ffed3c2529 Create a "Testing Applications" subsection in devel-examples
Move existing "regtest / testnet" texts to the new subsection and link to it
Move Bitcoin Core setup instructions in devel-examples
Add a consistent introduction for devel-(guide/ref/examples)
Fix autocrossref.rb to not add links inside {% highlight %} code blocks
2014-06-12 21:42:42 -04:00
David A. Harding
617213a980
Add Disclaimer & Anchor Affordance To Dev Examples 2014-06-02 13:07:27 -04:00
Saivann
c4a8c26465 Provide "GitHub-like" anchor links affordance (thanks @cbeams) 2014-05-24 23:44:51 -04:00
saivann
090c5dffa1 Merge pull request #416 from bitcoin/devel-docs-disclaimer
Add a temporary BETA disclaimer in devel-docs
2014-05-22 22:43:48 -04:00
David A. Harding
68cd5b6ff9
Several Corrections & Clarifications Suggested On IRC
**Suggested by @cbeams:**

_includes/ref_block_chain.md:

    * Mention that coinbase is the first transaction in a block.

**Suggested by @gmaxwell:**

_includes/ref_core_rpcs-abcdefg.md:

    * Mention that you need to unlock your wallet when you run out of
      keys in the keypool.

    * Remove erroneous assertion that txindex=1 would allow
      `getreceivedbyaddress` to check balances of addresses not
      belonging to this wallet.

_includes/ref_transactions.md:

    * Clarify that OP_RETURN scripts aren't usually executed because
      they always return false.

en/developer-reference.md

    * Add a warning about using block chain or mempool data in
      executable context.
2014-05-21 23:08:57 -04:00
Saivann
c7bc38f452 Add a temporary BETA disclaimer in devel-docs 2014-05-21 22:59:03 -04:00
saivann
b6a8926062 Merge pull request #411 from bitcoin/devel-report
Add "Report An Issue" action in developer documentation toc
2014-05-20 18:57:16 -04:00
Saivann
fecdbf0e93 Update "Report An Issue" link on mouseover (thanks @harding) 2014-05-19 18:39:18 -04:00
Saivann
753424d2e6 Add "Report An Issue" action in developer documentation toc 2014-05-19 12:02:34 -04:00
David A. Harding
e21d527523
Fix Formula For Normal HD Key Derivation; Mention Ancestor Key Risk
_includes/guide_wallets.md:

* Fix formula given for normal child key derivation to state that public
  keys must also be provided to the HMAC hash function. This required
  updating both text and images.

* Add one-paragraph warning about ancestor key compromise when the
  ancestor extended public key is compromised along with a descended
  private key.  Update img/dev/en-hd-private-parent-to-private-child.*
  to help illustrate this warning.

en/developer-reference.md:

* Remove %include% of previously-removed file which caused new versions
  of Jekyll to die.
2014-05-17 14:34:28 -04:00
saivann
46780d3177 Contributions by @saivann to devel docs
Thanks also (in alphabetical order) to @cbeams, @mikehearn, and
@tgeller, among others.

The last pre-squash commit was: c2b8d562aa107c7b68c60946cea14cdccc5159ad
2014-05-09 22:13:59 -04:00