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.

Sign up for GitHub

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

Jump to bottom

docs: revert docs link removal #6864

Merged
merged 6 commits into from
Jun 12, 2024
Merged

docs: revert docs link removal #6864

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
79b7d2c
fix: revert docs link removal
jeluard Jun 7, 2024
1317cb8
chore: address comments
jeluard Jun 11, 2024
eda50df
update links and fix broken links
philknows Jun 12, 2024
950ef08
fix lint
philknows Jun 12, 2024
c72efff
update wordlist
philknows Jun 12, 2024
8d7bc17
fix wordlist sort
philknows Jun 12, 2024
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
4 changes: 2 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ docs/pages/**/*-cli.md
docs/pages/assets
docs/pages/images
docs/pages/security.md
docs/pages/lightclient-prover/lightclient.md
docs/pages/lightclient-prover/prover.md
docs/pages/libraries/lightclient-prover/lightclient.md
docs/pages/libraries/lightclient-prover/prover.md
docs/pages/api/api-reference.md
docs/pages/contribution/getting-started.md
## Docusaurus
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
- :gear: Follow the installation method for [source install](https://chainsafe.github.io/lodestar/getting-started/installation/#build-from-source), [NPM install](https://chainsafe.github.io/lodestar/getting-started/installation/#install-from-npm-not-recommended), or [Docker install](https://chainsafe.github.io/lodestar/getting-started/installation/#docker-installation) to install Lodestar. Or use our [Lodestar Quickstart scripts](https://github.com/ChainSafe/lodestar-quickstart).
- :books: Use [Lodestar libraries](https://chainsafe.github.io/lodestar/supporting-libraries/libraries/) in your next Ethereum Typescript project.
- :globe_with_meridians: Run a beacon node on [mainnet or a public testnet](https://chainsafe.github.io/lodestar/getting-started/starting-a-node/).
- :computer: Utilize the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/advanced-topics/setting-up-a-testnet/).
- :computer: Utilize the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/contribution/advanced-topics/setting-up-a-testnet/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might wanna do some research if there is tooling that checks if all links work, we've broken so many links unnoticed before and it might be worth to set up some CI tooling for this

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good idea. For now, I've gone through the docs to fix broken links in eda50df

- :spiral_notepad: View the Lodestar [CLI commands and options](https://chainsafe.github.io/lodestar/reference/cli/).
- :nerd_face: View the [Package and dependency structure](https://chainsafe.github.io/lodestar/contribution/depgraph/).
- :memo: Prospective contributors can read the [contributing section](./CONTRIBUTING.md) to understand how we develop and test on Lodestar.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/run/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Binaries

Binaries can be downloaded from [this page](https://github.com/ChainSafe/lodestar/releases/) under the `Assets` section.
Binaries can be downloaded from [the release page](https://github.com/ChainSafe/lodestar/releases/latest) under the `Assets` section.

## Docker Installation

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/run/validator-management/vc-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Stake with a Validator Client
title: Starting a Validator Client
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to come up with some better title, "Validator Client" is redundant here. I liked the previous "Configuration" more, or maybe "Usage" (not sure myself)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For consistency with how we've named "Start a beacon node", I think we should just stick to "Starting a Validator Client." We can always follow up on a new PR in the future.

---

# Validator Configuration
Expand Down
14 changes: 6 additions & 8 deletions docs/sidebars.ts
View file
Open in desktop
jeluard marked this conversation as resolved.
Show resolved Hide resolved
jeluard marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,18 @@ import type {SidebarsConfig} from "@docusaurus/plugin-content-docs";
const sidebars: SidebarsConfig = {
tutorialSidebar: [
"index",
"introduction",
"security",
{
type: "category",
label: "Run A Node",
collapsed: false,
items: [
"run/getting-started/quick-start",
"run/getting-started/installation",
{
type: "category",
label: "Beacon node",
collapsed: false,
items: [
"run/beacon-management/starting-a-node",
"run/beacon-management/beacon-cli",
Expand All @@ -25,7 +27,6 @@ const sidebars: SidebarsConfig = {
{
type: "category",
label: "Validator Client",
collapsed: false,
items: [
"run/validator-management/vc-configuration",
"run/validator-management/validator-cli",
Expand All @@ -35,13 +36,11 @@ const sidebars: SidebarsConfig = {
{
type: "category",
label: "Logging and Metrics",
collapsed: false,
items: ["run/logging-and-metrics/prometheus-grafana", "run/logging-and-metrics/client-monitoring"],
},
{
type: "category",
label: "Discv5 Bootnode",
collapsed: false,
items: ["run/bootnode/bootnode-cli"],
},
],
Expand All @@ -53,12 +52,12 @@ const sidebars: SidebarsConfig = {
items: [
{
type: "category",
label: "Lodestar Light Client",
label: "Light Client",
items: ["libraries/lightclient-prover/lightclient-cli", "libraries/lightclient-prover/lightclient"],
},
{
type: "category",
label: "Lodestar Light Prover",
label: "Prover",
items: ["libraries/lightclient-prover/prover"],
},
],
Expand All @@ -73,14 +72,14 @@ const sidebars: SidebarsConfig = {
{
type: "category",
label: "Advanced Topics",
collapsed: false,
items: ["contribution/advanced-topics/setting-up-a-testnet"],
},
"contribution/depgraph",
{
type: "category",
label: "Development Tools",
items: [
"contribution/dev-cli",
"contribution/tools/debugging",
"contribution/tools/flamegraphs",
"contribution/tools/heap-dumps",
Expand All @@ -90,7 +89,6 @@ const sidebars: SidebarsConfig = {
{
type: "category",
label: "Testing",
collapsed: false,
items: [
"contribution/testing/index",
"contribution/testing/end-to-end-tests",
Expand Down
2 changes: 1 addition & 1 deletion packages/api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ You will need to go over the [specification](https://github.com/ethereum/beacon-
## Getting started

- Follow the [installation guide](https://chainsafe.github.io/lodestar/) to install Lodestar.
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/advanced-topics/setting-up-a-testnet/).
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/contribution/advanced-topics/setting-up-a-testnet/).

## Contributors

Expand Down
2 changes: 1 addition & 1 deletion packages/beacon-node/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You will need to go over the [specification](https://github.com/ethereum/consens
## Getting started

- Follow the [installation guide](https://chainsafe.github.io/lodestar/) to install Lodestar.
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/advanced-topics/setting-up-a-testnet/).
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/contribution/advanced-topics/setting-up-a-testnet/).

## Contributors

Expand Down
2 changes: 1 addition & 1 deletion packages/cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Command line tool for Lodestar
## Getting started

- Follow the [installation guide](https://chainsafe.github.io/lodestar/) to install Lodestar.
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/advanced-topics/setting-up-a-testnet/).
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/contribution/advanced-topics/setting-up-a-testnet/).

### Lodestar

Expand Down
2 changes: 1 addition & 1 deletion packages/reqresp/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ You will need to go over the [specification](https://github.com/ethereum/beacon-
## Getting started

- Follow the [installation guide](https://chainsafe.github.io/lodestar/) to install Lodestar.
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/advanced-topics/setting-up-a-testnet/).
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/contribution/advanced-topics/setting-up-a-testnet/).

## Contributors

Expand Down
2 changes: 1 addition & 1 deletion packages/validator/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ eth-consensus api compatible beacon nodes/databases/loggers.
## Getting started

- Follow the [installation guide](https://chainsafe.github.io/lodestar/) to install Lodestar.
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/advanced-topics/setting-up-a-testnet/).
- Quickly try out the whole stack by [starting a local testnet](https://chainsafe.github.io/lodestar/contribution/advanced-topics/setting-up-a-testnet/).

## License

Expand Down
Loading