Compat: use topic pages instead of pages + data files

Author: harding

CONTRIBUTING.md

@@ -98,9 +98,8 @@ diff -ruN _site _site.bak  # Compare the generated sites (-r for recursive, -u f
 ## Compatibility Matrix Data
 
 The compatibility matrix section of the website is built from
-[YAML](https://yaml.org/) files located in [_data/compatibility/](_data/compatibility/).
-Each wallet also requires a markdown file in
-[en/compatibility/](en/compatibility/). The compatibility images (usability
+[YAML](https://yaml.org/) files located in [_compat/en](_compat/en).
+The compatibility images (usability
 screenshots, logos) are located in [img/compatibility/](img/compatibility/) with
 sub-folders for each wallet or service. Make sure to optimize any png files using
 `optipng -o7 <filename>`. These files are free for anyone to repurpose/republish

Makefile

@@ -10,8 +10,8 @@ export GIT_PAGER='_contrib/kill0'
 JEKYLL_FLAGS = --future --drafts --unpublished --incremental
 
 ## Expected filenames in output directory
-compatibility_validation = $(wildcard _data/compatibility/*.yaml)
-compatibility_validation := $(patsubst _data/compatibility/%.yaml,_site/en/compatibility/%/index.html,$(compatibility_validation))
+compatibility_validation = $(wildcard _compat/en/*.md)
+compatibility_validation := $(patsubst _compat/en/%.md,_site/en/compatibility/%/index.html,$(compatibility_validation))
 topic_validation = $(wildcard _topics/en/*.md)
 topic_validation := $(patsubst _topics/en/%.md,_site/en/topics/%/index.html,$(topic_validation))
 
@@ -126,7 +126,7 @@ email: clean
 	$(MAKE) preview JEKYLL_ENV=email
 
 ## Path-based rules
-_site/en/compatibility/%/index.html : _data/compatibility/%.yaml
+_site/en/compatibility/%/index.html : _compat/en/%.md
 	bundle exec _contrib/schema-validator.rb _data/schemas/compatibility.yaml $<
 
 _site/en/topics/%/index.html : _topics/en/%.md

_data/compatibility/abra.yaml _compat/en/abra.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/abra/
+
 name: Abra
 internal_url: /en/compatibility/abra
 logo: /img/compatibility/abra/abra.png
@@ -62,26 +65,31 @@ segwit:
       bech32m: "untested"
       default: "p2pkh"
     send:
-      bech32: "false" 
+      bech32: "false"
       bech32m: "untested"
       change_bech32: "untested"
       segwit_v1: "Bech32 not supported."
       bech32_p2wsh: "false"
   examples:
     - image: /img/compatibility/abra/segwit/receive-screen.png
       caption: >
-        Abra uses P2PKH addresses for receiving. 
-    - image: /img/compatibility/abra/segwit/send-bech32.png  
+        Abra uses P2PKH addresses for receiving.
+    - image: /img/compatibility/abra/segwit/send-bech32.png
       caption: >
         Abra allows a bech32 address to be input and does not provide a warning.
         However, the review button was not enabled until a non-bech32 address
         was provided. The eventually sent transaction used exact change so
         change address format was not determined.
-    - image: /img/compatibility/abra/segwit/send-bech32-qr.png  
+    - image: /img/compatibility/abra/segwit/send-bech32-qr.png
       caption: >
         When using the QR code scanner, an error about address format was shown
         when scanning a bech32 address.
-    - image: /img/compatibility/abra/segwit/send-non-bech32.png  
+    - image: /img/compatibility/abra/segwit/send-non-bech32.png
       caption: >
         When using a non bech32 address, the "Review" button is enabled. Button
-        is disabled when using bech32 address format.
+        is disabled when using bech32 address format.
+---
+<!-- Abra -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/binance.yaml _compat/en/binance.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/binance/
+
 name: Binance
 internal_url: /en/compatibility/binance
 logo: /img/compatibility/binance/binance.png
@@ -47,15 +50,15 @@ segwit:
       bech32m: "false"
       default: "p2pkh"
     send:
-      bech32: "true" 
+      bech32: "true"
       bech32m: "false"
       change_bech32: "untested"
       segwit_v1: "Does not pass front end javascript validation"
       bech32_p2wsh: "false"
   examples:
     - image: /img/compatibility/binance/segwit/receive-screen.png
       caption: >
-        Binance receives via P2PKH addresses. 
+        Binance receives via P2PKH addresses.
     - image: /img/compatibility/binance/segwit/send-screen.png
       caption: >
         Default send screen accepts a bech32 address.
@@ -70,4 +73,9 @@ segwit:
         book screens.
     - image: /img/compatibility/binance/segwit/address-book-add.png
       caption: >
-        Bech32 P2WPKH addresses can be successfully added using the address book functionality.
+        Bech32 P2WPKH addresses can be successfully added using the address book functionality.
+---
+<!-- Binance -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/bitcoin-core.yaml _compat/en/bitcoin-core-wallet.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/bitcoin-core/
+
 name: Bitcoin Core Wallet
 internal_url: /en/compatibility/bitcoin-core
 logo: /img/compatibility/bitcoin-core/bitcoin-core.png
@@ -86,7 +89,7 @@ segwit:
       bech32m: "true"
       default: "p2sh_wrapped"
     send:
-      bech32: "true" 
+      bech32: "true"
       bech32m: "true"
       change_bech32: "true"
       segwit_v1: "Transaction can be created and broadcast, but does not make it
@@ -105,4 +108,9 @@ segwit:
       caption: >
         Send - By default, the change address takes the same type as the address
         being paid to. Can be overridden with change control's 'Custom change
-        address'.
+        address'.
+---
+<!-- Bitcoin Core Wallet -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/bitcoin-wallet.yaml _compat/en/bitcoin-wallet.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/bitcoin-wallet/
+
 # https://github.com/bitcoin-wallet/bitcoin-wallet
 name: Bitcoin Wallet
 internal_url: /en/compatibility/bitcoin-wallet
@@ -20,3 +23,8 @@ segwit:
       bech32m: "true"
       change_bech32: "true"
       bech32_p2wsh: "true"
+---
+<!-- Bitcoin Wallet -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/bitgo.yaml _compat/en/bitgo.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/bitgo/
+
 name: BitGo
 internal_url: /en/compatibility/bitgo
 logo: /img/compatibility/bitgo/bitgo.png
@@ -55,7 +58,7 @@ segwit:
       bech32m: "true"
       default: "p2sh_wrapped"
     send:
-      bech32: "true" 
+      bech32: "true"
       bech32m: "true"
       change_bech32: "true"
       segwit_v1: "Error occurs during sending process, after validation."
@@ -65,11 +68,16 @@ segwit:
       caption: >
         BitGo's web wallet UI defaults to P2SH-wrapped segwit addresses.
         Visually, the segwit logo is displayed next to segwit addresses with a
-        tooltip indicating "Wrapped Segwit". While bech32 receive addresses are 
-        not possible in the UI currently, bech32 receive addresses can be generated using the API. 
+        tooltip indicating "Wrapped Segwit". While bech32 receive addresses are
+        not possible in the UI currently, bech32 receive addresses can be generated using the API.
     - image: /img/compatibility/bitgo/segwit/send-screen.png
       caption: >
         BitGo's web wallet allows sending to bech32 addresses.
     #- image: /img/compatibility/bitgo/segwit/send-v1.png
     #  caption: >
-    #    BitGo's web wallet displays an error when attempting send to segwit v1 addresses.
+    #    BitGo's web wallet displays an error when attempting send to segwit v1 addresses.
+---
+<!-- BitGo -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/bitmex.yaml _compat/en/bitmex.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/bitmex/
+
 name: BitMEX
 internal_url: /en/compatibility/bitmex
 logo: /img/compatibility/bitmex/bitmex.png
@@ -47,3 +50,8 @@ segwit:
     - image: /img/compatibility/bitmex/segwit/receive-screen.png
       caption: >
         BitMEX uses a static P2SH address per user account.
+---
+<!-- BitMex -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/bitnob.yaml _compat/en/bitnob.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/bitnob/
+
 name: Bitnob
 internal_url: /en/compatibility/bitnob
 logo: /img/compatibility/bitnob/bitnob.png
@@ -55,3 +58,8 @@ segwit:
       caption: >
          Bitnob's default receive address type is p2wsh (native segwit)
 
+---
+<!-- BitNob -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/bitpowr.yaml _compat/en/bitpowr.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/bitpowr/
+
 name: Bitpowr
 internal_url: /en/compatibility/bitpowr
 logo: /img/compatibility/bitpowr/bitpowr.png
@@ -37,7 +40,7 @@ rbf:
     - image: /img/compatibility/bitpowr/rbf/transactions-list.png
       caption: >
         Receiving Transaction - Incoming transaction.
-   
+
 segwit:
   tested:
     date: "2021-08-17"
@@ -51,7 +54,7 @@ segwit:
       bech32m: "untested"
       default: "p2pkh"
     send:
-      bech32: "true" 
+      bech32: "true"
       bech32m: "untested"
       change_bech32: "true"
       segwit_v1: "true"
@@ -65,5 +68,10 @@ segwit:
         Bitpowr supports sending to bech32, p2pkh and p2sh wrapped addresses via the API and UI.
     - image: /img/compatibility/bitpowr/segwit/send-change-segwit.png
       caption: >
-        Bitpowr supports bech32, p2pkh and p2sh wrapped change addresses. You can choose via the API 
+        Bitpowr supports bech32, p2pkh and p2sh wrapped change addresses. You can choose via the API
         and its default to bech32 on dashboard.
+---
+<!-- BitPowr -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/bitrefill.yaml _compat/en/bitrefill.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/bitrefill/
+
 name: Bitrefill
 internal_url: /en/compatibility/bitrefill
 logo: /img/compatibility/bitrefill/bitrefill.png
@@ -50,7 +53,7 @@ segwit:
       bech32m: "untested"
       default: "p2sh_wrapped"
     send:
-      bech32: "true" 
+      bech32: "true"
       bech32m: "untested"
       change_bech32: "true"
       segwit_v1: "Address does not pass validation."
@@ -64,4 +67,9 @@ segwit:
         Bitrefill can send to bech32 native addresses. Change address is also bech32.
     #- image: /img/compatibility/bitrefill/segwit/send-v1.png
     #  caption: >
-    #    Bitrefill displays an address validation error for segwit v1 addresses.
+    #    Bitrefill displays an address validation error for segwit v1 addresses.
+---
+<!-- Bitrefill -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/bitstamp.yaml _compat/en/bitstamp.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/bitstamp/
+
 name: Bitstamp
 internal_url: /en/compatibility/bitstamp
 logo: /img/compatibility/bitstamp/bitstamp.png
@@ -59,3 +62,8 @@ segwit:
     - image: /img/compatibility/bitstamp/segwit/receive-screen.png
       caption: >
         Bitstamp receives deposits to P2SH-P2WSH addresses.
+---
+<!-- BitStamp -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/blockchaininfo.yaml _compat/en/blockchaininfo.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/blockchaininfo/
+
 name: Blockchain.info
 internal_url: /en/compatibility/blockchaininfo
 logo: /img/compatibility/blockchaininfo/blockchaininfo.png
@@ -48,7 +51,7 @@ segwit:
       bech32m: "true"
       default: "bech32"  # https://github.com/bitcoinops/bitcoinops.github.io/pull/510#issuecomment-859732513
     send:
-      bech32: "true" 
+      bech32: "true"
       bech32m: "true"
       change_bech32: "true"  # https://github.com/bitcoinops/bitcoinops.github.io/pull/510#issuecomment-859732513
       segwit_v1: "Error occurs during sending process, after validation."
@@ -64,3 +67,8 @@ segwit:
     #  caption: >
     #    Blockchain initially allows to send to segwit v1 addresses but an error
     #    occurs after completing the send process.
+---
+<!-- Blockchain.info -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/blocksettle.yaml _compat/en/blocksettle.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/blocksettle/
+
 name: BlockSettle
 internal_url: /en/compatibility/blocksettle
 logo: /img/compatibility/blocksettle/blocksettle.png
@@ -67,7 +70,7 @@ segwit:
       bech32m: "untested"
       default: "bech32"
     send:
-      bech32: "true" 
+      bech32: "true"
       bech32m: "untested"
       change_bech32: "true"
       segwit_v1: "Error message during broadcasting of transaction"
@@ -92,3 +95,8 @@ segwit:
       caption: >
         The change address defaults to native bech32 segwit addresses, however,
         it is manually selectable by the user
+---
+<!-- BlockSettle -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}

_data/compatibility/casa.yaml _compat/en/casa.md

@@ -1,4 +1,7 @@
 ---
+layout: page
+permalink: /en/compatibility/casa/
+
 name: Casa
 internal_url: /en/compatibility/casa
 logo: /img/compatibility/casa/casa.png
@@ -43,7 +46,7 @@ segwit:
       bech32m: "untested"
       default: "p2sh_wrapped_p2wsh"
     send:
-      bech32: "true" 
+      bech32: "true"
       bech32m: "true"
       change_bech32: "false"
       segwit_v1: "Fails on signing attempt."
@@ -56,3 +59,8 @@ segwit:
       caption: >
         Casa Keymaster allows sending to bech32 addresses. Change addresses
         are not bech32 native, but P2SH-wrapped segwit addresses.
+---
+<!-- Casa -->
+
+{% assign tool = page %}
+{% include templates/compatibility-page.md %}