docs: update docsgen scripting and add new docs content (#6134)

* docs: rouged out changes to layout, TOC and started writing

* docs: add more docs for beacon-management

* docs: add database update and light-client examples

* docs: make spelling consistent in lightclient example

* refactor: move assets into docs folder

* docs: fix filenames and write testing and simtest content

* fix contributing navigation

* enable emojis on docs

* docs: update testing toc

* feat(docs): update cli docs rendering

* refactor(docs): move lightclient and prover into folder

* docs: add docsFolder prop to cli commands

* feat: create CliOptionDefinition and standardize flare and prover with existing

* fix: debug docs rendering edge cases

* fix: cleanup docs TOC

* fix: update docs scripts and workflow

* refactor: move docs/gitignore line to root gitignore

* feat: remove old comments

* fix: CI lint errors

* chore: lint docs

* chore: lint spelling

* feat: add check-spelling script

* fix: bug in build:docs if folder not present

* test: fix failing unit test

* chore: add gitignore changes to dockerignore

* feat: check README ts examples and cop

* chore: add pre to wordlist

* docs: add heap-dumps.md

* chore: lint spelling

* refactor: move assets back to root

* docs: add core-dumps and add to heap-dumps

* fix: put back unit test after moving assets back

* docs: update beacon-management/networking.md

Co-authored-by: Cayman <[email protected]>

* docs: update beacon-management/networking.md

Co-authored-by: Cayman <[email protected]>

* docs: update beacon-management/networking.md

Co-authored-by: Cayman <[email protected]>

* docs: update beacon-management/networking.md

Co-authored-by: Cayman <[email protected]>

* docs: update beacon-management/networking.md

Co-authored-by: Cayman <[email protected]>

* docs: update beacon-management/networking.md

Co-authored-by: Cayman <[email protected]>

* docs: update contribution/testing/index.md

Co-authored-by: Cayman <[email protected]>

* docs: update beacon-management/syncing.md

Co-authored-by: Cayman <[email protected]>

* docs: update contribution/testing/index.md

Co-authored-by: Cayman <[email protected]>

* docs: update contribution/testing/index.md

Co-authored-by: Cayman <[email protected]>

* docs: update supporting libraries

* docs: update for PR comments

* docs: fix broken lings and clean up TOC

* docs: clean up simulation-test and move integration stuff out to placeholder file

* chore: remove duplicate word in .wordlist.txt

* docs: fix data retention diagram

* fix: PR comments in docs

* docs: rewreite Proof of Stake intro

---------

Co-authored-by: Phil Ngo <[email protected]>
Co-authored-by: Cayman <[email protected]>

.dockerignore

@@ -46,11 +46,11 @@ packages/beacon-node/mainnet_pubkeys.csv
 # Autogenerated docs
 packages/**/docs
 packages/**/typedocs
-docs/packages
-docs/contributing.md
-docs/assets
-docs/reference/cli.md
-/site
+docs/pages/**/*-cli.md
+docs/pages/assets
+docs/pages/api/api-reference.md
+docs/pages/contribution/getting-started.md
+docs/site
 
 # Lodestar artifacts
 .lodestar

.github/workflows/docs.yml

@@ -45,15 +45,17 @@ jobs:
         uses: actions/setup-python@v1
 
       - name: Install dependencies
+        working-directory: docs
         run: |
           python -m pip install --upgrade pip
-          pip install -r docs/requirements.txt
+          pip install -r requirements.txt
 
       - name: Build docs
-        run: mkdocs build --site-dir site -v --clean
+        working-directory: docs
+        run: mkdocs build --verbose --clean --site-dir site
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./site
+          publish_dir: ./docs/site

.gitignore

@@ -40,11 +40,14 @@ packages/api/oapi-schemas
 # Autogenerated docs
 packages/**/docs
 packages/**/typedocs
-docs/assets
-docs/packages
-docs/reference
-docs/contributing.md
-/site
+docs/pages/**/*-cli.md
+docs/pages/assets
+docs/pages/images
+docs/pages/lightclient-prover/lightclient.md
+docs/pages/lightclient-prover/prover.md
+docs/pages/api/api-reference.md
+docs/pages/contribution/getting-started.md
+docs/site
 
 # Testnet artifacts
 .lodestar

.wordlist.txt

@@ -1,14 +1,19 @@
 APIs
+Andreas
+Antonopoulos
 AssemblyScript
 BLS
 BeaconNode
 Besu
+Buterin
 CLA
 CLI
 CTRL
+Casper
 Chai
 ChainSafe
 Customizations
+DPoS
 Discv
 DockerHub
 Dockerized
@@ -19,22 +24,33 @@ ENR
 ENRs
 ESLint
 ETH
+Edgington
 Erigon
 EthStaker
+EtherScan
 Ethereum
+EthereumJS
+FINDNODE
 FX
 Flamegraph
 Flamegraphs
+Geth
 Github
 Gossipsub
 Grafana
 HackMD
+Homebrew
+IPFS
 IPv
 Infura
 JSON
+JSObjects
 JWT
+KDE
 LGPL
 LGPLv
+LMD
+LPoS
 LTS
 Lerna
 MEV
@@ -45,10 +61,12 @@ NVM
 Nethermind
 NodeJS
 NodeSource
+OSI
 PR
 PRs
 Plaintext
 PoS
+Prysm
 Quickstart
 RPC
 SHA
@@ -57,64 +75,102 @@ SSZ
 Stakehouse
 TOC
 TTD
+Teku
 TypeScript
 UI
 UID
+UPnP
 UTF
 VM
 Vitalik
 Wagyu
 api
 async
+backfill
 beaconcha
+blockchain
 bootnode
 bootnodes
 chainConfig
 chainsafe
+chiado
 cli
 cmd
+codebase
 config
 configs
 const
 constantish
 coreutils
 cors
+cryptocurrency
 cryptographic
 dApp
 dApps
+ddos
 decrypt
 deserialization
+dev
 devnet
 devnets
+devtools
+eg
+enodes
 enum
+env
 envs
+ephemery
 flamegraph
 flamegraphs
+gnosis
 goerli
+heapdump
+heaptrack
+holesky
 interop
+js
 keypair
 keystore
 keystores
+libp
 lightclient
 linter
+lldb
+llnode
 lockfile
 mainnet
+malloc
 mdns
 merkle
 merkleization
 monorepo
+multiaddr
+multifork
 namespace
 namespaced
 namespaces
 nodemodule
+orchestrator
+osx
 overriden
 params
+pid
 plaintext
+pre
+premined
 produceBlockV
+protolambda
 prover
+repo
+repos
 req
 reqresp
+responder
+ropsten
 runtime
+scalability
+secp
+sepolia
 sharding
 ssz
 stakers
@@ -131,4 +187,6 @@ utils
 validator
 validators
 wip
+xcode
 yaml
+yamux