Merge pull request #1 from flashbots/main

update

Author: freddmannen

.github/workflows/broken-link-check-cron.yml

@@ -0,0 +1,16 @@
+name: Check for broken links (cron)
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 10 * * *'
+
+jobs:
+  check-for-broken-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-node@v1
+        with:
+          node-version: '16.x'
+      - run: npm install -g linkinator
+      - run: linkinator https://docs.flashbots.net --recurse --timeout 3000 --concurrency 10 --retry -s https://dune.com/ChainsightAnalytics,'https://.*etherscan.io/tx.*','https://twitter.com.*','https://.*imgur.com.*'

.github/workflows/pr-tests.yml

@@ -1,28 +1,28 @@
 name: PR Tests
 
-on: 
+on:
+  push:
+    branches:
+      - main
   pull_request:
-    branches: "staging"
 
 jobs:
-  build:
-    if: github.event_name != 'push'
+  build-and-check:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: '12.x'
-      - name: Test Build
+          node-version: '16.x'
+      - name: Test build
         env:
-          TARGET_URL: "http://not-docs.flashbots.net"
-          BASE_URL: "/docs/"
+          TARGET_URL: "https://docs.flashbots.net"
+          BASE_URL: "/"
         run: |
-          if [ -e yarn.lock ]; then
           yarn install --frozen-lockfile
-          elif [ -e package-lock.json ]; then
-          npm ci
-          else
-          npm i
-          fi
-          npm run build
+          yarn build
+      - name: Check for broken links
+        run: |
+          cd build
+          npm install -g linkinator
+          linkinator "**/*.html" --recurse --timeout 3000 --concurrency 10 --retry -s https://dune.com/ChainsightAnalytics,'https://.*etherscan.io/.*','https://twitter.com.*','https://.*imgur.com.*'

.github/workflows/production-deploy.yml

@@ -0,0 +1 @@
+v16.14.2

.nvmrc

@@ -1,9 +1,17 @@
 # Website
 
-This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator. 
+This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
 
 ## Installation
 
+Use Node.js v18+
+
+Note: if you want to install the node packages from within a Docker container (recommended for security), then you can start it like this:
+
+```sh
+docker run -p 3000:3000 --rm -it -w /mnt -v $(pwd):/mnt node:18 /bin/bash
+```
+
 First create a copy of the environment file `.env.template` in the root of the codebase and rename it to `.env`
 
 Then run the following:
@@ -18,7 +26,9 @@ yarn install
 yarn start
 ```
 
-This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
+This command starts a local development server (and may open up a browser window). Some changes are reflected live without having to restart the server.
+
+You can open the local docs at [http://localhost:3000/docs](http://localhost:3000/docs)
 
 ## Build
 
@@ -30,8 +40,6 @@ This command generates static content into the `build` directory and can be serv
 
 ## Deployment
 
-```console
-GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
-```
+Create a PR and once merged, Github actions automatically deploy it.
 
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+The docs use Vercel for hosting, and deployment is done by Vercel on any merge into the master branch.

README.md

@@ -1,5 +1,5 @@
 ---
-title: docs cheatsheet
+title: Docs Cheatsheet
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';

docs/cheatsheet.mdx

@@ -1,5 +1,5 @@
 ---
-title: code of conduct
+title: Code of Conduct
 ---
 
 At Flashbots we contribute with the larger free software community to illuminate the dark forest.

docs/code-of-conduct.mdx

@@ -1,5 +1,5 @@
 ---
-title: community tools
+title: Community Tools
 ---
 
 ### [Flashbots Bundle Explorer](http://flashbots-explorer.marto.lol/)
@@ -8,10 +8,26 @@ title: community tools
 - Search by block number
 - Shareable permalinks (e.g. https://flashbots-explorer.marto.lol/?block=12506647)
 
-[![Flashbots Bundle Explorer](/img/bundle-explorer.png)](http://flashbots-explorer.marto.lol/)
+### [Mevboost.org](https://www.mevboost.org/)
 
-### [flashbots.tools](https://flashbots.tools/)
+- Dashboard tracking the top relayers and builders of MEV-Boost.
 
-Simple frontend to interface with https://github.com/flashbots
+### [MEV-Boost Dashboard](https://dune.com/ChainsightAnalytics/mev-after-ethereum-merge)
 
-![Flashbots Tools](/img/flashbots-tools.png)
+- Overview of MEV-Boost adoption and profitability of proposers and block builders.
+
+### [mevboost.pics](https://mevboost.pics/)
+
+- Interactive dashboard of the MEV-Boost relay and builder markets.
+
+### [MEV Watch](https://www.mevwatch.info/)
+
+- Visualization of the number of blocks proposed by MEV-Boost relays excluding certain transactions compared to content agnostic relays.
+
+### [Relay Monitor by Metrika](https://app.metrika.co/dashboard/ethereum/relay-monitor/north-america-east?tr=1d)
+
+- Monitor the bids, blocks and latency of MEV-Boost Relays.
+
+### [Rated Network](https://www.rated.network/?network=mainnet&view=pool&timeWindow=1d&page=1)
+
+- Information about validators, pools, relays, etc.

docs/community-tools.mdx

@@ -1,5 +1,5 @@
 ---
-title: docs contribution guide
+title: Docs Contribution Guide
 ---
 Thank you for your interest in adding to our knowledge base!
 
@@ -27,7 +27,7 @@ We've created a simple cheatsheet file with examples of every heading, code bloc
     - the render bot will comment a link on your PR others can use to look at the version of the staging-docs website with your PR implemented [eg.](https://github.com/flashbots/docs/pull/23)
 
 **Step 4:** Changes to staging branch (PRs) are reviewed and merged by *docs* admins
-- after review, PRs are merged to the staging branch and your changes are now deployed live to the [staging docs website](https://docs-staging.flashbots.net/)
+- after review, PRs are merged to the staging branch and your changes are now deployed live to the staging docs website
 
 **Step 5:** Once enough changes have been collected/time is right, staging branch is merged into main branch by *docs* admins
 - changes are now deployed live to the [docs website](https://docs.flashbots.net/)

docs/contribution-guide.mdx

@@ -1,5 +1,5 @@
 ---
-title: other resources
+title: Other Resources
 ---
 
 Remember you can ask any questions in the [#🐣newcomers or #🤖searchers](https://discord.com/invite/7hvTycdNcK) channel on our Discord, or in one of the Self Support Groups on [our forum](https://collective.flashbots.net/).