FLR-916: Adding search boost to the metadata (#333)

This promotes pages deemed as more important in the search results, and demotes the ones that should not show in search results so often.
flare-foundation · Mar 4, 2024 · b3c49e1 · b3c49e1
1 parent 069b279
commit b3c49e1
Show file tree

Hide file tree

Showing 23 changed files with 88 additions and 4 deletions.
diff --git a/docs/dev/reference/network-config.md b/docs/dev/reference/network-config.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # Network Configuration
 
 ## Flare Networks
@@ -211,8 +216,8 @@ For a production-grade option check out Flare's [API Portal](../../tech/api-port
     * The execution layer creates blocks with transactions and executes smart contracts.
     * The consensus layer, sometimes referred to as the beacon chain, governs consensus and was the extra layer required for the Ethereum 2.0 proof-of-stake (PoS) merge.
 
-    These two layers have their own API, which can be called from the provided nodes. When querying the Ethereum network nodes, specifying only the root path `/` will target the execution layer API. Prefixing your path with `/eth` will target the consensus layer API. 
-    
+    These two layers have their own API, which can be called from the provided nodes. When querying the Ethereum network nodes, specifying only the root path `/` will target the execution layer API. Prefixing your path with `/eth` will target the consensus layer API.
+
     Official API specifications for each layer:
 
     * [Consensus Layer - API Spec](https://ethereum.github.io/beacon-APIs/#/)
@@ -268,7 +273,7 @@ For a production-grade option check out Flare's [API Portal](../../tech/api-port
             -d '{"jsonrpc": "2.0", "id":67, "method":"eth_blockNumber", "params":[]}' \
             https://sepolia-api.flare.network | jq
             ```
-        
+
 ??? info "Filecoin"
 
     * **RPC endpoint**: `https://filecoin-api.flare.network/rpc/v1`

diff --git a/docs/dev/tutorials/ftso/getting-data-feeds.md b/docs/dev/tutorials/ftso/getting-data-feeds.md
@@ -1,6 +1,8 @@
 ---
 og_image: assets/thumbnails/tutorial-ftso-1.png
 og_description: This tutorial shows the simplest way to use the FTSO system to retrieve a specific data feed, like the price of Bitcoin.
+search:
+  boost: 2
 ---
 
 # Getting FTSO Data Feeds

diff --git a/docs/tech/api-portal.md b/docs/tech/api-portal.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # Flare API Portal
 
 Flare's API Portal is a paid product that gives developers access to a number of **private nodes** running on different blockchains, including Flare, [Songbird](glossary.md#songbird) and [Coston](glossary.md#coston), but also other networks like Bitcoin or XRPL.

diff --git a/docs/tech/archive/flare-launch-process.md b/docs/tech/archive/flare-launch-process.md
@@ -1,6 +1,8 @@
 ---
 og_image: assets/thumbnails/launch-process-thumb.png
 og_description: The goal of this page is to remove any confusion around Flare's launch process.
+search:
+  boost: 0.5
 ---
 
 # Flare Launch Process

diff --git a/docs/tech/archive/index.md b/docs/tech/archive/index.md
@@ -1,6 +1,8 @@
 ---
 section_icon: tech-icon.svg
 section_icon_type: filled-svg
+search:
+  boost: 0.5
 ---
 
 # Archive

diff --git a/docs/tech/automatic-claiming.md b/docs/tech/automatic-claiming.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # Automatic Claiming
 
 Automatic claiming enables users to appoint an executor to claim rewards on their behalf.

diff --git a/docs/tech/fassets/collateral.md b/docs/tech/fassets/collateral.md
@@ -1,5 +1,7 @@
 ---
 title: Collateral
+search:
+  boost: 2
 ---
 
 # FAssets Collateral

diff --git a/docs/tech/fassets/index.md b/docs/tech/fassets/index.md
@@ -1,6 +1,8 @@
 ---
 og_image: assets/thumbnails/fassets-concept.png
 og_description: The FAssets system allows tokens on blockchains that do not support smart contracts to be used trustlessly with smart contracts on the Flare blockchain.
+search:
+  boost: 2
 ---
 
 # FAssets

diff --git a/docs/tech/fassets/liquidation.md b/docs/tech/fassets/liquidation.md
@@ -1,5 +1,7 @@
 ---
 title: Liquidation
+search:
+  boost: 2
 ---
 
 # FAssets Liquidation

diff --git a/docs/tech/fassets/minting.md b/docs/tech/fassets/minting.md
@@ -1,5 +1,7 @@
 ---
 title: Minting
+search:
+  boost: 2
 ---
 
 # FAssets Minting

diff --git a/docs/tech/fassets/redemption.md b/docs/tech/fassets/redemption.md
@@ -1,5 +1,7 @@
 ---
 title: Redemption
+search:
+  boost: 2
 ---
 
 # FAssets Redemption

diff --git a/docs/tech/flare-beta.md b/docs/tech/flare-beta.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # Flare Beta
 
 Decentralization will be achieved by moving the transaction validation duty **from the Flare Foundation to community-run FTSO** [data providers](glossary.md#data_provider), but this will not happen instantly.

diff --git a/docs/tech/flare.md b/docs/tech/flare.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # What Is Flare?
 
 !!! image inline end ""

diff --git a/docs/tech/ftso.md b/docs/tech/ftso.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # FTSO
 
 The **Flare Time Series Oracle** (FTSO) is a smart contract running on the Flare network that **provides continuous estimations for different types of data**. It does so in a **decentralized manner** (no single party is in control of the process) and **securely** (it takes a lot of effort to disrupt the process).

diff --git a/docs/tech/glossary.md b/docs/tech/glossary.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # Glossary
 
 Account { #account }

diff --git a/docs/tech/governance.md b/docs/tech/governance.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # Governance
 
 ## Introduction

diff --git a/docs/tech/index.md b/docs/tech/index.md
@@ -1,6 +1,8 @@
 ---
 section_icon: tech-icon.svg
 section_icon_type: filled-svg
+search:
+  boost: 2
 ---
 
 # Flare Fundamentals

diff --git a/docs/tech/personal-delegation-account.md b/docs/tech/personal-delegation-account.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 1
+---
+
 # Personal Delegation Accounts
 
 Flare token holders are eligible to receive a number of rewards, for example through [FTSO Delegation](./ftso.md#delegation).

diff --git a/docs/tech/state-connector.md b/docs/tech/state-connector.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # State Connector
 
 ## Introduction

diff --git a/docs/tech/the-flaredrop.md b/docs/tech/the-flaredrop.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 1
+---
+
 # The FlareDrop
 
 The FlareDrop, previously called the _Delegation Incentive Pool_ in the [FIP.01](https://flare.network/fip01/), is a distribution method for the 24.25B remaining `$FLR` tokens after the [original airdrop](./archive/flare-launch-process.md#definitions).

diff --git a/docs/tech/validators.md b/docs/tech/validators.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # Validator Nodes
 
 ## Blockchain Validation

diff --git a/docs/user/wrapping-tokens.md b/docs/user/wrapping-tokens.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 2
+---
+
 # Wrapping Flare Tokens
 
 This information explains how to wrap and unwrap native tokens on various Flare networks using the [Flare Portal](https://portal.flare.network) or the block explorer.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -56,7 +56,8 @@ markdown_extensions:
   - pymdownx.snippets           # Import files with --8<--
   - footnotes                   # Footnotes with [^1]
 plugins:
-  - search                      # Search box at the top
+  - search:                     # Search box at the top
+      separator: '[$\s\-,:!=\[\]()"/]+'
   - git-revision-date           # Last edit timestamp at the bottom
   - swagger-ui-tag:             # Renders OpenApi Spec
       extra_css: