De-boost smart contract API pages from search

flare-smart-contracts 51d7a33f state-connector-protocol 2ad84ea
flare-foundation · Mar 4, 2024 · 069b279 · 069b279
1 parent 07e1a41
commit 069b279
Show file tree

Hide file tree

Showing 79 changed files with 161 additions and 3 deletions.
diff --git a/docgen/build-docs.sh b/docgen/build-docs.sh
@@ -121,13 +121,17 @@ print_yml $internal_interfaces
 mv ../mkdocs.yml.tmp ../mkdocs.yml
 
 # Copy all pages to the docs repo
-# In the process, special-case links to files that exist in the "attestation-types" folder,
-# and replace them with the correct link.
 attestation_types=$(ls ../docs/apis/attestation-types)
 attestation_types=$(echo $attestation_types | sed "s/ /|/g")
 for f in $contracts $interfaces $internal_interfaces;
 do
+    # In the process, special-case links to files that exist in the "attestation-types" folder,
+    # and replace them with the correct link.
     cat $f | sed -E "s%(\[[^]]*\]\()\./(($attestation_types)\))%\1../attestation-types/\2%g" > $docs/$(basename $f)
+    # And insert a search de-boost, since these pages should not typically be the first result returned by search.
+    sed -i '2 a \
+search:\
+  boost: 0.5' $docs/$(basename $f)
 done
 sed -i -E "s%(\[[^]]*\]\()\./(($attestation_types)\))%\1../attestation-types/\2%g" $docs/index.md
 

diff --git a/docgen/repos.list b/docgen/repos.list
@@ -1,2 +1,2 @@
 [email protected]:flarenetwork/flare-smart-contracts.git master https://gitlab.com/flarenetwork/flare-smart-contracts/-/tree/master hardhatSetup.config.ts yarn compile
-[email protected]:flarenetwork/state-connector-protocol.git STAT-28 https://github.com/flare-foundation/songbird-state-connector-protocol/tree/main hardhat.config.ts yarn hardhat compile
+[email protected]:flarenetwork/state-connector-protocol.git main https://github.com/flare-foundation/songbird-state-connector-protocol/tree/main hardhat.config.ts yarn hardhat compile
diff --git a/docs/apis/smart-contracts/AddressUpdatable.md b/docs/apis/smart-contracts/AddressUpdatable.md
@@ -1,5 +1,7 @@
 ---
 title: AddressUpdatable
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/AddressUpdater.md b/docs/apis/smart-contracts/AddressUpdater.md
@@ -1,5 +1,7 @@
 ---
 title: AddressUpdater
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/AddressValidityVerification.md b/docs/apis/smart-contracts/AddressValidityVerification.md
@@ -1,5 +1,7 @@
 ---
 title: AddressValidityVerification
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/BalanceDecreasingTransactionVerification.md b/docs/apis/smart-contracts/BalanceDecreasingTransactionVerification.md
@@ -1,5 +1,7 @@
 ---
 title: BalanceDecreasingTransactionVerification
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/CheckPointable.md b/docs/apis/smart-contracts/CheckPointable.md
@@ -1,5 +1,7 @@
 ---
 title: CheckPointable
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/ClaimSetupManager.md b/docs/apis/smart-contracts/ClaimSetupManager.md
@@ -1,5 +1,7 @@
 ---
 title: ClaimSetupManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/CleanupBlockNumberManager.md b/docs/apis/smart-contracts/CleanupBlockNumberManager.md
@@ -1,5 +1,7 @@
 ---
 title: CleanupBlockNumberManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/CloneFactory.md b/docs/apis/smart-contracts/CloneFactory.md
@@ -1,5 +1,7 @@
 ---
 title: CloneFactory
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/ConfirmedBlockHeightExistsVerification.md b/docs/apis/smart-contracts/ConfirmedBlockHeightExistsVerification.md
@@ -1,5 +1,7 @@
 ---
 title: ConfirmedBlockHeightExistsVerification
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/Delegatable.md b/docs/apis/smart-contracts/Delegatable.md
@@ -1,5 +1,7 @@
 ---
 title: Delegatable
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/EVMTransactionVerification.md b/docs/apis/smart-contracts/EVMTransactionVerification.md
@@ -1,5 +1,7 @@
 ---
 title: EVMTransactionVerification
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/FlareContractRegistry.md b/docs/apis/smart-contracts/FlareContractRegistry.md
@@ -1,5 +1,7 @@
 ---
 title: FlareContractRegistry
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/FlareDaemon.md b/docs/apis/smart-contracts/FlareDaemon.md
@@ -1,5 +1,7 @@
 ---
 title: FlareDaemon
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/Ftso.md b/docs/apis/smart-contracts/Ftso.md
@@ -1,5 +1,7 @@
 ---
 title: Ftso
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/FtsoManager.md b/docs/apis/smart-contracts/FtsoManager.md
@@ -1,5 +1,7 @@
 ---
 title: FtsoManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/FtsoRegistry.md b/docs/apis/smart-contracts/FtsoRegistry.md
@@ -1,5 +1,7 @@
 ---
 title: FtsoRegistry
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/FtsoRewardManager.md b/docs/apis/smart-contracts/FtsoRewardManager.md
@@ -1,5 +1,7 @@
 ---
 title: FtsoRewardManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/GovernanceSettings.md b/docs/apis/smart-contracts/GovernanceSettings.md
@@ -1,5 +1,7 @@
 ---
 title: GovernanceSettings
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/GovernanceVotePower.md b/docs/apis/smart-contracts/GovernanceVotePower.md
@@ -1,5 +1,7 @@
 ---
 title: GovernanceVotePower
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/Governed.md b/docs/apis/smart-contracts/Governed.md
@@ -1,5 +1,7 @@
 ---
 title: Governed
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/GovernedAndFlareDaemonized.md b/docs/apis/smart-contracts/GovernedAndFlareDaemonized.md
@@ -1,5 +1,7 @@
 ---
 title: GovernedAndFlareDaemonized
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/GovernedAtGenesis.md b/docs/apis/smart-contracts/GovernedAtGenesis.md
@@ -1,5 +1,7 @@
 ---
 title: GovernedAtGenesis
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/GovernedBase.md b/docs/apis/smart-contracts/GovernedBase.md
@@ -1,5 +1,7 @@
 ---
 title: GovernedBase
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IAddressValidityVerification.md b/docs/apis/smart-contracts/IAddressValidityVerification.md
@@ -1,5 +1,7 @@
 ---
 title: IAddressValidityVerification
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IBalanceDecreasingTransactionVerification.md b/docs/apis/smart-contracts/IBalanceDecreasingTransactionVerification.md
@@ -1,5 +1,7 @@
 ---
 title: IBalanceDecreasingTransactionVerification
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IClaimSetupManager.md b/docs/apis/smart-contracts/IClaimSetupManager.md
@@ -1,5 +1,7 @@
 ---
 title: IClaimSetupManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IConfirmedBlockHeightExistsVerification.md b/docs/apis/smart-contracts/IConfirmedBlockHeightExistsVerification.md
@@ -1,5 +1,7 @@
 ---
 title: IConfirmedBlockHeightExistsVerification
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IEVMTransactionVerification.md b/docs/apis/smart-contracts/IEVMTransactionVerification.md
@@ -1,5 +1,7 @@
 ---
 title: IEVMTransactionVerification
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IFlareContractRegistry.md b/docs/apis/smart-contracts/IFlareContractRegistry.md
@@ -1,5 +1,7 @@
 ---
 title: IFlareContractRegistry
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IFlareDaemonize.md b/docs/apis/smart-contracts/IFlareDaemonize.md
@@ -1,5 +1,7 @@
 ---
 title: IFlareDaemonize
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IFtso.md b/docs/apis/smart-contracts/IFtso.md
@@ -1,5 +1,7 @@
 ---
 title: IFtso
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IFtsoGenesis.md b/docs/apis/smart-contracts/IFtsoGenesis.md
@@ -1,5 +1,7 @@
 ---
 title: IFtsoGenesis
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IFtsoManager.md b/docs/apis/smart-contracts/IFtsoManager.md
@@ -1,5 +1,7 @@
 ---
 title: IFtsoManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IFtsoManagerGenesis.md b/docs/apis/smart-contracts/IFtsoManagerGenesis.md
@@ -1,5 +1,7 @@
 ---
 title: IFtsoManagerGenesis
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IFtsoRegistry.md b/docs/apis/smart-contracts/IFtsoRegistry.md
@@ -1,5 +1,7 @@
 ---
 title: IFtsoRegistry
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IFtsoRegistryGenesis.md b/docs/apis/smart-contracts/IFtsoRegistryGenesis.md
@@ -1,5 +1,7 @@
 ---
 title: IFtsoRegistryGenesis
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IFtsoRewardManager.md b/docs/apis/smart-contracts/IFtsoRewardManager.md
@@ -1,5 +1,7 @@
 ---
 title: IFtsoRewardManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IGovernanceSettings.md b/docs/apis/smart-contracts/IGovernanceSettings.md
@@ -1,5 +1,7 @@
 ---
 title: IGovernanceSettings
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IGovernanceVotePower.md b/docs/apis/smart-contracts/IGovernanceVotePower.md
@@ -1,5 +1,7 @@
 ---
 title: IGovernanceVotePower
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IIAddressUpdatable.md b/docs/apis/smart-contracts/IIAddressUpdatable.md
@@ -1,5 +1,7 @@
 ---
 title: IIAddressUpdatable
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IIAddressUpdater.md b/docs/apis/smart-contracts/IIAddressUpdater.md
@@ -1,5 +1,7 @@
 ---
 title: IIAddressUpdater
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IIClaimSetupManager.md b/docs/apis/smart-contracts/IIClaimSetupManager.md
@@ -1,5 +1,7 @@
 ---
 title: IIClaimSetupManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IICleanable.md b/docs/apis/smart-contracts/IICleanable.md
@@ -1,5 +1,7 @@
 ---
 title: IICleanable
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IIFtso.md b/docs/apis/smart-contracts/IIFtso.md
@@ -1,5 +1,7 @@
 ---
 title: IIFtso
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IIFtsoManager.md b/docs/apis/smart-contracts/IIFtsoManager.md
@@ -1,5 +1,7 @@
 ---
 title: IIFtsoManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IIFtsoRegistry.md b/docs/apis/smart-contracts/IIFtsoRegistry.md
@@ -1,5 +1,7 @@
 ---
 title: IIFtsoRegistry
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->

diff --git a/docs/apis/smart-contracts/IIFtsoRewardManager.md b/docs/apis/smart-contracts/IIFtsoRewardManager.md
@@ -1,5 +1,7 @@
 ---
 title: IIFtsoRewardManager
+search:
+  boost: 0.5
 ---
 
 <!-- This is an autogenerated file. Do not edit! -->