Prepare documentation files for processing

looterz · Aug 16, 2017 · d7c7837 · d7c7837
1 parent 2b9db69
commit d7c7837
Show file tree

Hide file tree

Showing 19 changed files with 80 additions and 98 deletions.
diff --git a/_devdocs/examples/intro.md b/_devdocs/examples/intro.md
@@ -1,7 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 {% assign filename="_includes/devdoc/example_intro.md" %}
 
 The following guide aims to provide examples to help you start

diff --git a/_devdocs/examples/p2p_networking.md b/_devdocs/examples/p2p_networking.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/example_p2p_networking.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## P2P Network
 

diff --git a/_devdocs/examples/payment_processing.md b/_devdocs/examples/payment_processing.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/example_payment_processing.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Payment Processing
 

diff --git a/_devdocs/examples/testing.md b/_devdocs/examples/testing.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/example_testing.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Testing Applications
 

diff --git a/_devdocs/examples/transactions.md b/_devdocs/examples/transactions.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/example_transactions.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Transactions
 

diff --git a/_devdocs/guides/block_chain.md b/_devdocs/guides/block_chain.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/guide_block_chain.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Block Chain
 

diff --git a/_devdocs/guides/contracts.md b/_devdocs/guides/contracts.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/guide_contracts.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Contracts
 

diff --git a/_devdocs/guides/intro.md b/_devdocs/guides/intro.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 The Developer Guide aims to provide the information you need to understand
 Bitcoin and start building Bitcoin-based applications, but it is [not a
 specification][]. To make the best use of

diff --git a/_devdocs/guides/mining.md b/_devdocs/guides/mining.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/guide_mining.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Mining
 

diff --git a/_devdocs/guides/operating_modes.md b/_devdocs/guides/operating_modes.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/guide_operating_modes.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Operating Modes
 

diff --git a/_devdocs/guides/p2p_network.md b/_devdocs/guides/p2p_network.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/guide_p2p_network.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## P2P Network
 

diff --git a/_devdocs/guides/payment_processing.md b/_devdocs/guides/payment_processing.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/guide_payment_processing.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Payment Processing
 

diff --git a/_devdocs/guides/transactions.md b/_devdocs/guides/transactions.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/guide_transactions.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Transactions
 

diff --git a/_devdocs/guides/wallets.md b/_devdocs/guides/wallets.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/guide_wallets.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Wallets
 

diff --git a/_devdocs/references/block_chain.md b/_devdocs/references/block_chain.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/ref_block_chain.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Block Chain
 

diff --git a/_devdocs/references/intro.md b/_devdocs/references/intro.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/ref_intro.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 The Developer Reference aims to provide technical details and API information
 to help you start building Bitcoin-based applications, but it is [not a

diff --git a/_devdocs/references/p2p_networking.md b/_devdocs/references/p2p_networking.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/ref_p2p_networking.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## P2P Network
 

diff --git a/_devdocs/references/transactions.md b/_devdocs/references/transactions.md
@@ -1,8 +1,7 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/ref_transactions.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
 ## Transactions
 
@@ -151,7 +150,7 @@ bytes commonly used by Bitcoin are:
 
 4. Append the checksum to the version and hash, and encode it as a base58
    string: <!--[-->`BASE58(version . hash . checksum)`<!--]-->
- 
+
 Bitcoin's base58 encoding, called [Base58Check][/en/glossary/base58check]{:#term-base58check}{:.term} may not match other implementations. Tier
 Nolan provided the following example encoding algorithm to the Bitcoin
 Wiki [Base58Check
@@ -164,7 +163,7 @@ x = convert_bytes_to_big_integer(hash_result)
 
 output_string = ""
 
-while(x > 0) 
+while(x > 0)
    {
        (x, remainder) = divide(x, 58)
        output_string.append(code_string[remainder])
@@ -210,7 +209,7 @@ A raw transaction has the following top-level format:
 | *Varies* | tx_in        | txIn                | Transaction inputs.  See description of txIn below.
 | *Varies* | tx_out count | compactSize uint    | Number of outputs in this transaction.
 | *Varies* | tx_out       | txOut               | Transaction outputs.  See description of txOut below.
-| 4        | lock_time    | uint32_t            | A time (Unix epoch time) or block number.  See the [locktime parsing rules][]. 
+| 4        | lock_time    | uint32_t            | A time (Unix epoch time) or block number.  See the [locktime parsing rules][].
 
 A transaction may have multiple inputs and outputs, so the txIn and
 txOut structures may recur within a transaction. CompactSize unsigned

diff --git a/_devdocs/references/wallets.md b/_devdocs/references/wallets.md
@@ -1,10 +1,9 @@
-{% comment %}
-This file is licensed under the MIT License (MIT) available on
-http://opensource.org/licenses/MIT.
-{% endcomment %}
-{% assign filename="_includes/devdoc/ref_wallets.md" %}
+---
+# This file is licensed under the MIT License (MIT) available on
+# http://opensource.org/licenses/MIT.
+---
 
-## Wallets 
+## Wallets
 
 ### Deterministic Wallet Formats
 <!-- no subhead-links here -->