Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 50 commits into from
Dec 12, 2023
Merged
Show file tree
Hide file tree
Changes from 43 commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
ba4c129
docs: rouged out changes to layout, TOC and started writing
matthewkeil Oct 10, 2023
8a3554e
docs: add more docs for beacon-management
matthewkeil Oct 11, 2023
d3978d4
docs: add database update and light-client examples
matthewkeil Oct 11, 2023
0cb341e
docs: make spelling consistent in lightclient example
matthewkeil Oct 11, 2023
eaf337a
refactor: move assets into docs folder
matthewkeil Oct 12, 2023
f188914
docs: fix filenames and write testing and simtest content
matthewkeil Oct 23, 2023
45f81ef
fix contributing navigation
philknows Oct 13, 2023
bf83691
enable emojis on docs
philknows Oct 13, 2023
b412f88
docs: update testing toc
matthewkeil Oct 23, 2023
7903521
feat(docs): update cli docs rendering
matthewkeil Nov 27, 2023
7fa2a10
refactor(docs): move lightclient and prover into folder
matthewkeil Nov 27, 2023
1519310
docs: add docsFolder prop to cli commands
matthewkeil Nov 27, 2023
53c5332
feat: create CliOptionDefinition and standardize flare and prover wit…
matthewkeil Nov 27, 2023
5eab549
fix: debug docs rendering edge cases
matthewkeil Nov 28, 2023
af585a4
fix: cleanup docs TOC
matthewkeil Nov 28, 2023
2ebcb0e
fix: update docs scripts and workflow
matthewkeil Nov 28, 2023
f026629
refactor: move docs/gitignore line to root gitignore
matthewkeil Nov 28, 2023
1953bd0
feat: remove old comments
matthewkeil Nov 28, 2023
c695040
fix: CI lint errors
matthewkeil Nov 28, 2023
368362a
chore: lint docs
matthewkeil Nov 28, 2023
e238dc1
chore: lint spelling
matthewkeil Nov 28, 2023
0231475
feat: add check-spelling script
matthewkeil Nov 28, 2023
6d958da
fix: bug in build:docs if folder not present
matthewkeil Nov 28, 2023
23127aa
test: fix failing unit test
matthewkeil Nov 28, 2023
2599c6f
chore: add gitignore changes to dockerignore
matthewkeil Nov 28, 2023
909a84a
feat: check README ts examples and cop
matthewkeil Nov 28, 2023
c621df0
chore: add pre to wordlist
matthewkeil Nov 28, 2023
3941582
docs: add heap-dumps.md
matthewkeil Dec 5, 2023
e72a2e9
chore: lint spelling
matthewkeil Dec 5, 2023
1cfd8fb
refactor: move assets back to root
matthewkeil Dec 7, 2023
bc7f5a3
docs: add core-dumps and add to heap-dumps
matthewkeil Dec 7, 2023
6e4cbf3
fix: put back unit test after moving assets back
matthewkeil Dec 7, 2023
ad9cc07
docs: update beacon-management/networking.md
matthewkeil Dec 8, 2023
3e4f147
docs: update beacon-management/networking.md
matthewkeil Dec 8, 2023
95ae1c7
docs: update beacon-management/networking.md
matthewkeil Dec 8, 2023
66de2d8
docs: update beacon-management/networking.md
matthewkeil Dec 8, 2023
fe89f0f
docs: update beacon-management/networking.md
matthewkeil Dec 8, 2023
a467677
docs: update beacon-management/networking.md
matthewkeil Dec 8, 2023
1a9572d
docs: update contribution/testing/index.md
matthewkeil Dec 8, 2023
62c2676
docs: update beacon-management/syncing.md
matthewkeil Dec 8, 2023
1a6c669
docs: update contribution/testing/index.md
matthewkeil Dec 8, 2023
84f233a
docs: update contribution/testing/index.md
matthewkeil Dec 8, 2023
b19e63e
docs: update supporting libraries
matthewkeil Dec 8, 2023
d4331b5
docs: update for PR comments
matthewkeil Dec 9, 2023
a49c439
docs: fix broken lings and clean up TOC
matthewkeil Dec 10, 2023
8806bd9
docs: clean up simulation-test and move integration stuff out to plac…
matthewkeil Dec 10, 2023
07579b7
chore: remove duplicate word in .wordlist.txt
matthewkeil Dec 10, 2023
0972552
docs: fix data retention diagram
matthewkeil Dec 10, 2023
b3dbda8
fix: PR comments in docs
matthewkeil Dec 11, 2023
3f1d3c0
docs: rewreite Proof of Stake intro
matthewkeil Dec 11, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 5 additions & 3 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
13 changes: 8 additions & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
53 changes: 53 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
APIs
Andreas
Antonopoulos
AssemblyScript
BLS
BeaconNode
Besu
Buterin
CLA
CLI
CTRL
Casper
Chai
ChainSafe
Customizations
DPoS
Discv
DockerHub
Dockerized
Expand All @@ -19,22 +24,32 @@ ENR
ENRs
ESLint
ETH
Edgington
Erigon
EthStaker
EtherScan
Ethereum
EthereumJS
FX
Flamegraph
Flamegraphs
Geth
Github
Gossipsub
Grafana
HackMD
Homebrew
IPFS
IPv
Infura
JSON
JSObjects
JWT
KDE
LGPL
LGPLv
LMD
LPoS
LTS
Lerna
MEV
Expand All @@ -45,10 +60,12 @@ NVM
Nethermind
NodeJS
NodeSource
OSI
PR
PRs
Plaintext
PoS
Prysm
Quickstart
RPC
SHA
Expand All @@ -57,63 +74,98 @@ SSZ
Stakehouse
TOC
TTD
Teku
TypeScript
UI
UID
UPnP
UTF
VM
Vitalik
Wagyu
api
async
beaconcha
blockchain
bootnode
bootnodes
chainConfig
chainsafe
chiado
cli
cmd
codebase
config
configs
const
constantish
cors
cryptocurrency
cryptographic
dApp
dApps
ddos
decrypt
deserialization
dev
devnet
devnets
devtools
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
ropsten
runtime
scalability
secp
sepolia
sharding
ssz
stakers
Expand All @@ -130,4 +182,5 @@ utils
validator
validators
wip
xcode
yaml
29 changes: 0 additions & 29 deletions docs/install/docker.md

This file was deleted.

6 changes: 0 additions & 6 deletions docs/install/npm.md

This file was deleted.

Loading
Loading