Intro docs

.github/workflows/docs.yml

@@ -74,12 +74,12 @@ jobs:
       - name: Check the docs for broken links (root)
         if: github.event_name == 'pull_request'
         working-directory: docs
-        run: bundle exec htmlproofer --disable-external --allow-hash-href --assume-extension ./_site --url-swap '^/firefly/:/' --url-ignore /127.0.0.1/,/localhost/
+        run: bundle exec htmlproofer --disable-external --allow-hash-href --allow_missing_href true --swap-urls '^/firefly/:/' --ignore-urls /127.0.0.1/,/localhost/ ./_site
 
       - name: Check the docs for broken links (version)
         if: github.event_name != 'pull_request'
         working-directory: docs
-        run: bundle exec htmlproofer --disable-external --allow-hash-href --assume-extension ./_site --url-swap '^/firefly/${{ env.DOCS_VERSION }}/:/' --url-ignore /127.0.0.1/,/localhost/
+        run: bundle exec htmlproofer --disable-external --allow-hash-href --allow_missing_href true --swap-urls '^/firefly/${{ env.DOCS_VERSION }}/:/' --ignore-urls /127.0.0.1/,/localhost/ ./_site
 
       - name: Deploy docs (version)
         if: github.event_name == 'push'

.vscode/settings.json

@@ -4,6 +4,7 @@
   ],
   "go.lintTool": "golangci-lint",
   "cSpell.words": [
+    "actioned",
     "APIID",
     "autometa",
     "bifactory",

Makefile

@@ -102,4 +102,4 @@ manifest:
 docker:
 		./docker_build.sh $(DOCKER_ARGS)
 docs: .ALWAYS
-		cd docs && bundle install && bundle exec jekyll build && bundle exec htmlproofer --disable-external --allow-hash-href --assume-extension ./_site --url-swap '^/firefly/:/' --url-ignore /127.0.0.1/,/localhost/
+		cd docs && bundle install && bundle exec jekyll build && bundle exec htmlproofer --disable-external --allow-hash-href --allow_missing_href true --swap-urls '^/firefly/:/' --ignore-urls /127.0.0.1/,/localhost/ ./_site

docs/Gemfile.lock

@@ -1,20 +1,20 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.5)
+    activesupport (6.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    addressable (2.8.0)
-      public_suffix (>= 2.0.2, < 5.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
     coffee-script-source (1.11.1)
     colorator (1.1.0)
-    commonmarker (0.23.4)
+    commonmarker (0.23.5)
     concurrent-ruby (1.1.10)
     dnsruby (1.61.9)
       simpleidn (~> 0.1)
@@ -25,33 +25,14 @@ GEM
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
     execjs (2.8.1)
-    faraday (1.10.0)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0)
-      faraday-multipart (~> 1.0)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.0)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      faraday-retry (~> 1.0)
+    faraday (2.5.2)
+      faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.3)
-      multipart-post (>= 1.2, < 3)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday-retry (1.0.3)
+    faraday-net_http (3.0.0)
     ffi (1.15.5)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
-    github-pages (226)
+    github-pages (227)
       github-pages-health-check (= 1.17.9)
       jekyll (= 3.9.2)
       jekyll-avatar (= 0.7.0)
@@ -93,7 +74,7 @@ GEM
       liquid (= 4.0.3)
       mercenary (~> 0.3)
       minima (= 2.5.1)
-      nokogiri (>= 1.13.4, < 2.0)
+      nokogiri (>= 1.13.6, < 2.0)
       rouge (= 3.26.0)
       terminal-table (~> 1.4)
     github-pages-health-check (1.17.9)
@@ -102,17 +83,18 @@ GEM
       octokit (~> 4.0)
       public_suffix (>= 3.0, < 5.0)
       typhoeus (~> 1.3)
-    html-pipeline (2.14.1)
+    html-pipeline (2.14.2)
       activesupport (>= 2)
       nokogiri (>= 1.4)
-    html-proofer (3.19.4)
+    html-proofer (4.4.0)
       addressable (~> 2.3)
       mercenary (~> 0.3)
       nokogiri (~> 1.13)
       parallel (~> 1.10)
       rainbow (~> 3.0)
       typhoeus (~> 1.3)
       yell (~> 2.0)
+      zeitwerk (~> 2.5)
     http_parser.rb (0.8.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
@@ -239,20 +221,19 @@ GEM
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.15.0)
-    multipart-post (2.1.1)
-    nokogiri (1.13.6-arm64-darwin)
+    minitest (5.16.3)
+    nokogiri (1.13.8-arm64-darwin)
       racc (~> 1.4)
-    octokit (4.22.0)
-      faraday (>= 0.9)
-      sawyer (~> 0.8.0, >= 0.5.3)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
     parallel (1.22.1)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.7)
     racc (1.6.0)
     rainbow (3.1.1)
-    rb-fsevent (0.11.1)
+    rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rexml (3.2.5)
@@ -265,25 +246,25 @@ GEM
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    sawyer (0.8.2)
+    sawyer (0.9.2)
       addressable (>= 2.3.5)
-      faraday (> 0.8, < 2.0)
+      faraday (>= 0.17.3, < 3)
     simpleidn (0.2.1)
       unf (~> 0.1.4)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
-    tzinfo (1.2.9)
+    tzinfo (1.2.10)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.8.1)
+    unf_ext (0.0.8.2)
     unicode-display_width (1.8.0)
     webrick (1.7.0)
     yell (2.2.2)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   arm64-darwin-21

docs/_config.yml

@@ -4,7 +4,7 @@ title: Hyperledger FireFly Docs
 baseurl: /firefly
 aux_links:
   "GitHub":
-    - "//github.com/hyperledger/firefly"
+    - "https://github.com/hyperledger/firefly"
   "Wiki":
     - "https://wiki.hyperledger.org/display/FIR"
   "Discord":

docs/_i18n/en.yml

@@ -4,33 +4,50 @@ langs:
 site:
   title: Hyperledger FireFly Docs
 pages:
-  home: Home
   advanced_cli_usage: Advanced CLI Usage
-  api_spec: API Spec
-  architecture: Architecture
   api_post_syntax: API Post Syntax
   api_query_syntax: API Query Syntax
-  blockchain_protocols: Blockchain protocols
-  broadcast_shared_data: Broadcast / shared data
+  api_spec: API Spec
+  apps: Apps
+  arbitrum: Arbitrum Testnet
+  architecture: Architecture
+  avalanche: Avalanche Testnet
+  binance_smart_chain: Binance Smartchain Testnet
+  blockchain_protocols: Blockchain Protocols
   broadcast_data: Broadcast data
+  broadcast_data: Broadcast Data
+  broadcast_shared_data: Broadcast / Shared Data
+  chains: Connecting to remote blockchains
   code_hierarchy: FireFly Code Hierarchy
   code_overview: FireFly Code Overview
   code_repositories: Code Repositories
   configuration_reference: Configuration Reference
+  connector_framework: Connector Framework
   contributors: Contributors
   custom_smart_contracts: Work with custom smart contracts
+  data_security: Data Security
+  deterministic: Deterministic Compute
+  digital_assets: Digital Assets
   faqs: FAQs
+  firefly_core: Firefly Core
+  flows: Flows
   getting_started: Getting Started
-  private_data_exchange: Private data exchange
+  home: Home
+  introduction: Introduction
+  key_features: Key Features
+  moonbeam_testnet: Moonbeam Testnet
+  multiparty_features: Multiparty Features
+  multiparty_flow: Multiparty Process Flow
+  near: NEAR Testnet
+  optimism: Optimism Testnet
+  orchestration_engine: Orchestration Engine
+  polygon_testnet: Polygon Testnet
+  private_data_exchange: Private Data Exchange
   reference: Reference
+  remote_fabric_network: Remote Fabric Network
+  security: Security
+  tools: Tools
   tutorials: Tutorials
   understanding_firefly: Understanding FireFly
-  chains:  Connecting to remote blockchains
-  remote_fabric_network: Remote Fabric Network
-  polygon_testnet: Polygon Testnet
-  arbitrum: Arbitrum Testnet
-  avalanche: Avalanche Testnet
-  binance_smart_chain: Binance Smartchain Testnet
-  near: NEAR Testnet
-  optimism: Optimism Testnet
-  moonbeam_testnet: Moonbeam Testnet
+  usage_patterns: Usage Patterns
+  web3_gateway_features: Web3 Gateway Features

docs/_i18n/en/index.md

@@ -2,12 +2,19 @@
 
 ![Hyperledger FireFly](./images/hyperledger_firefly_social.png)
 
-Hyperledger FireFly is the first open source Supernode: a complete stack for enterprises to build and scale secure Web3 applications.
+Hyperledger FireFly is an [open source Supernode](./overview/supernode_concept.html), a complete stack for enterprises to build and scale secure Web3 applications.
 
-The FireFly API for digital assets, data flows, and blockchain transactions makes it radically faster to build production-ready apps on popular chains and protocols.
+The easiest way to understand a FireFly Supernode is to think of it like a toolbox. Connect your existing apps and/or back office systems to the toolbox and within it there are two different sets of tools. One set of tools helps you connect to the Web3 world that already exists, and the other set allows you to build new decentralized applications quickly with security and scalability.
+
+Head to the [Understanding FireFly](./overview/supernode_concept.html) section for more details.
+
+## Table of contents
 
 - [Understanding FireFly](./overview/)
+- [Getting Started](./gettingstarted/)
+- [Tutorials](./tutorials/)
 - [Reference](./reference/)
 - [Architecture](./architecture/)
 - [Contributors](./contributors/)
 - [API Spec](./swagger/swagger.html)
+- [FAQs](./faqs/)