Commit graph

12 commits

Author SHA1 Message Date
David A. Harding
73eb097dd4
Dev Docs: REST: Add Security Note & Reindex Note
Added both notes to both JSON-RPC and REST docs.

Suggested by Jonas Schnelli (thanks!)
2015-01-26 14:41:05 -05:00
David A. Harding
9329c69cf8
Dev Docs: Put RPC Tables In Separate CSS Class
Suggested by Saivann: RPC tables with Name/Type/Presence/Description
format are now in .ntpd CSS class so that we can format them specially.

We also change the style of all dev doc tables to replace bold table
headings (thead) with a double-line border-bottom.  This makes the
theads look less like section headings and prevents us from over-using
bold.

Minor: a Makefile warning message has been made more explicit (also
suggested by Saivann) and another Makefile rule was updated to catch
more broken tables.
2014-12-30 16:03:19 -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
Saivann
d7db481feb Use consistent lowercase "bitcoin-cli" 2014-12-21 13:48:52 -05:00
Saivann
33b989dc34 Align RPC names in tables 2014-12-21 13:48:32 -05:00
David A. Harding
51a5a1b24a
Dev Docs: Briefly Describe JSON-RPC Format & bitcoin-cli
Briefly describe the JSON-RPC 1.0 format as used by Bitcoin Core and how
bitcoin-cli abstracts away some of the details.   Also link to the
Proper Money Handling wiki page.  (This as a vanguard PR preparing the
way for a larger overhaul of our RPC docs, including updating them for
0.10.)
2014-12-19 16:45:46 -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
David A. Harding
6ae33424e5
Change Text Alignment & Fix Some Typos
* Replaced text justification with left-align (raggedright) for all text
  in dev docs.

    * Removed previous manual left-align in RPC byte order table

* Changed placement of See Below text partly based on a suggestion by
  @saivann (thanks!)

* Normalized capitialization of special structures (e.g. s/TxIn/txIn/)
  to be consistent with some other parts of the docs. (I don't think
  we're fully consistent on this in all parts of the docs. I'll put a
  rule in the style guide today and then we can make changes on the next
  global proofread.)

* Fixed missing period found by @saivann (thanks!) and a related missing
  preposition.
2014-11-04 14:30:57 -05:00
David A. Harding
10f6de368d
Treat Mainnet And Testnet As Common Nouns, Lowercasing When Appropriate
Suggested by @saivann (thanks!)
2014-10-29 08:16:59 -04:00
David A. Harding
0f8504e204
Reorder Links (No URL Or Text Changes) & Fix Tiny Typo
* Sorted the _includes/references.md file as it became unclear where
  links should be added.

* Fixed accidentally lowercased "merkle" at start of sentence.
2014-10-25 15:12:55 -04: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