Skip to content

Commit

Permalink
Fix links for mdx files. (#711)
Browse files Browse the repository at this point in the history
* Fix links for mdx files.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

* fix run a node link.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

* Get package-lock.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

* Apply suggestions from code review

Co-authored-by: m4sterbunny <harrie.bickle@consensys.net>

* Broken link.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

* Address feedback.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>

---------

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Co-authored-by: m4sterbunny <harrie.bickle@consensys.net>
  • Loading branch information
bgravenorst and m4sterbunny committed Sep 2, 2024
1 parent 34c795f commit 3f4c112
Show file tree
Hide file tree
Showing 22 changed files with 130 additions and 80 deletions.
4 changes: 2 additions & 2 deletions docs/architecture/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,6 @@ _...in other words, there's a lot involved._

## Next steps

- Learn more about the different components that comprise the [Linea](architecture/stack).
- Learn more about the different components that comprise the [Linea architecture](./stack/index.mdx).
- Understand the first point of contact for many new L2 users, the bridge. Linea has more than one bridge; and that number is likely to continue to
grow. The [Linea canonical message service](architecture/stack/canonical-msg-service) is key to these bridges and how they function.
grow. The [Linea canonical message service](./stack/canonical-msg-service/index.mdx) is key to these bridges and how they function.
8 changes: 4 additions & 4 deletions docs/architecture/overview/transaction-lifecycle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Ethereum, where they become pending transactions.

## Step 2: Block building

The Linea [sequencer](/architecture/stack/sequencer) is responsible for ordering, building, and executing blocks.
The Linea [sequencer](../stack/sequencer/index.mdx) is responsible for ordering, building, and executing blocks.
For each transaction added to the mempool, the sequencer checks its validity, rejecting
transactions as necessary. Transaction validity conditions are specific to Linea, and differ
slightly from those on other networks, including Ethereum.
Expand All @@ -36,7 +36,7 @@ generate ZK proofs. Let's press on.
## Step 3: Transaction data sent to the state manager

Data about the transaction and the state of the network at its time of execution are recorded
in **traces**, an output of part of the sequencer called the [trace generator](/architecture/stack/sequencer/traces-generator).
in **traces**, an output of part of the sequencer called the [trace generator](../stack/sequencer/traces-generator.md).

Traces are passed to the state manager block-by-block and then used to update the network state.
Once state is up to date, you'll see the transaction reflected and confirmed in your wallet.
Expand All @@ -48,7 +48,7 @@ before true finality is reached.

## Step 4: Conflation

The transaction's block will then be subject to [conflation](/architecture/stack/sequencer/conflation), which
The transaction's block will then be subject to [conflation](../stack/sequencer/conflation.md), which
combines two or more blocks' transaction data into a single data set (batch) that forms part of
the package of data passed on to Ethereum. Combining the transaction data of multiple blocks
means that a single proof can be used to verify a large volume of transactions, minimizing the
Expand All @@ -66,7 +66,7 @@ With the block that contains the transaction's trace data conflated into a batch
more others, the only remaining task on the checklist to achieve **_hard_ finality** is to use
the transaction's data—as contained in its trace—to generate a proof.

When prompted by the [Coordinator](/architecture/stack/coordinator), Linea's [prover](/architecture/stack/trace-expansion-proving)
When prompted by the [Coordinator](../stack/coordinator/index.mdx), Linea's [prover](../stack/trace-expansion-proving/index.mdx)
will first **expand** the trace, preparing it for inclusion in the proof. Linea's prover employs
a two-stage method for developing the proofs that eventually get passed to L1, first developing
an **inner proof** and then an **outer proof**.
Expand Down
4 changes: 2 additions & 2 deletions docs/architecture/stack/bridges/canonical-token-bridge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ import TabItem from "@theme/TabItem";
</div>

The canonical token bridge is the pair of “lock & mint” contracts that allow bridging of any
ERC-20 token. The bridge relies on the [message service](../canonical-msg-service/message-service)
ERC-20 token. The bridge relies on the [message service](../canonical-msg-service/message-service.mdx)
for cross-chain interactions.

The Linea team operates a UI for this bridge, available at [https://bridge.linea.build/](https://bridge.linea.build/).
The Linea team operates a UI for the [official Linea bridge](https://bridge.linea.build/).

The canonical token bridge is optimized for technical partners who are deploying on Linea.
We recommend that everyday users of Linea seeking to bridge their personal tokens between
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/stack/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The repository contains the elements of Linea responsible for this process.
The Linea implementation of Hyperledger Besu, an Ethereum client, extended with plugins.

As Linea is EVM-equivalent, it is compatible with standard Ethereum clients without plugins; for
example, you can also [run a Linea node using Geth](/developers/guides/run-a-node/use-binary#run-the-geth-client).
example, you can also [run a Linea node using Geth](../../developers/guides/run-a-node/index.mdx).

### [`linea-sequencer`](https://github.com/Consensys/linea-sequencer)

Expand Down
10 changes: 7 additions & 3 deletions docs/developers/community/hackathons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,15 @@ All winners have the opportunity to bring their project to fruition through a va
And be featured on [X](https://twitter.com/lineabuild), [Linea Farcaster](https://warpcast.com/linea), and livestreams!

:::info
[**Get started through the Linea Builder Launchpad**](https://aspecta.id/builder-matrix/Linea-builder-launchpad) to find the one-stop shop for claiming builder NFTs, applying for the Linea Builders Club, getting access to developer workshops, and other Linea developer activations.
[**Get started through the Linea Builder Launchpad**](https://aspecta.id/builder-matrix/Linea-builder-launchpad)
to find the one-stop shop for claiming builder NFTs, applying for the Linea Builders Club, getting
access to developer workshops, and other Linea developer activations.

[**Apply for the Linea Builders Club**](https://linea.deform.cc/linea-builders-club) to get exclusive access to tech talks, events, the Linea team, and more!
[**Apply for the Linea Builders Club**](https://linea.deform.cc/linea-builders-club) to get exclusive
access to tech talks, events, the Linea team, and more!

[**Join the Consensys Developer Chat**](https://t.me/+rI-iPLacQXQ5MDVh) for IRL hackathons and get connected with the MetaMask, Phosphor, and Verax teams!
[**Join the Consensys Developer Chat**](https://t.me/+rI-iPLacQXQ5MDVh) for IRL hackathons and get
connected with the MetaMask, Phosphor, and Verax teams!
:::

## Helpful links
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Create NFTs that evolve based on user actions.
---

Data on Irys is permanent and immutable, but you can use
[Irys' mutable references](https://docs.irys.xyz/developer-docs/mutable-references) to simulate
[Irys' mutable references](https://arweave-tools.irys.xyz/irys-sdk/mutable-references) to simulate
mutability and create dynamic NFTs that evolve based on onchain or offchain actions.

With mutable references, you create a single, static URL that is linked to a series of transactions.
Expand Down
14 changes: 7 additions & 7 deletions docs/developers/guides/community/irys/irys-nfts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ image: /img/socialCards/create-an-nft.jpg
description: Build permanent NFTs using Irys and Linea.
---

You can use [Irys](/developers/tooling/permanent-data/irys/overview) to create an NFT on Linea. To do this:
You can use [Irys](../../../tooling/permanent-data/irys/overview.mdx) to create an NFT on Linea. To do this:

1. Deploy your smart contract on Linea
2. Permanently store your NFT assets on Irys
Expand All @@ -15,16 +15,16 @@ collectors benefit from the assurance that their NFTs are preserved indefinitely
images stored are Irys are permanent and immutable.

:::note
You can also use Irys to create [dynamic NFTs](./irys-dynamic-nfts) that evolve based on onchain or
You can also use Irys to create [dynamic NFTs](./irys-dynamic-nfts.mdx) that evolve based on onchain or
offchain actions.
:::

## Deploy your smart contract

If you're new to NFTs and smart contract development, consider deploying
one of [the audited ThirdWeb contracts](/developers/quickstart/deploy-smart-contract/thirdweb) to learn more.
one of [the audited ThirdWeb contracts](../../../../developers/quickstart/deploy-smart-contract/thirdweb.md) to learn more.

You can also [deploy this minimal contract using Remix](/developers/quickstart/deploy-smart-contract/remix).
You can also [deploy this minimal contract using Remix](../../../../developers/quickstart/deploy-smart-contract/remix.md).

```solidity
// SPDX-License-Identifier: MIT
Expand Down Expand Up @@ -75,9 +75,9 @@ contract IrysLineaNFT is ERC721, ERC721URIStorage, Ownable {
Uploads to Irys are fully unconstrained; you can upload files of any size and use Irys to make
images, videos, music, or interactive NFTs.

This guide covers using the [Irys CLI](/developers/tooling/permanent-data/irys/irys-quickstart#irys-cli) to
This guide covers using the [Irys CLI](../../../tooling/permanent-data/irys/irys-quickstart.mdx#irys-cli) to
upload your assets to Irys. You can also do the same using the
[Irys SDK](/developers/tooling/permanent-data/irys/irys-quickstart#irys-sdk).
[Irys SDK](../../../tooling/permanent-data/irys/irys-quickstart.mdx#irys-sdk).

### Store your visual assets

Expand Down Expand Up @@ -178,4 +178,4 @@ irys upload metadata.json \
## Mint the NFTs

Now use your metadata URLs (in the format `https://gateway.irys.xyz/:txId`) to mint the NFTs
using [the contract you deployed on Linea](/developers/quickstart/deploy-smart-contract).
using [the contract you deployed on Linea](../../../../developers/quickstart/deploy-smart-contract/index.mdx).
4 changes: 2 additions & 2 deletions docs/developers/guides/gas/gas-fees.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ components:

## Estimating transaction costs

Use the [`linea_estimateGas`](/developers/reference/api/linea-estimategas) API method to estimate the
Use the [`linea_estimateGas`](../../reference/api/linea-estimategas.mdx) API method to estimate the
gas cost for sending a transaction. The method returns the recommended gas limit, the base fee per
gas, and the priority fee per gas.

The `linea_estimateGas` endpoint is currently unavailable. For more information, see
our [reference page](/developers/reference/api/linea-estimategas).
our [reference page](../../reference/api/linea-estimategas.mdx).

:::info important

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/guides/run-a-node/use-binary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Download the genesis file and Besu configuration file.
You can choose from a range of edge nodes (enodes) for Linea Mainnet. The Besu `config-mainnet.toml`
file uses all enodes by default.

See our [enodes page](./enodes) for a full list of available enodes.
See our [enodes page](./enodes.mdx) for a full list of available enodes.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/developers/guides/run-a-node/use-docker.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ files include the network genesis file, Docker Compose file and Besu configurati
config file named `config-snap-mainnet.toml` where enodes are specified. The file uses all enodes
by default.

See our [enodes page](./enodes) for a full list of available enodes.
See our [enodes page](./enodes.mdx) for a full list of available enodes.
:::

</TabItem>
Expand Down
Loading

0 comments on commit 3f4c112

Please sign in to comment.