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

Minimal restructure to demo Concept/How To/Reference/Tutorial approach #420

Merged
merged 9 commits into from
Feb 9, 2025
4 changes: 4 additions & 0 deletions docs/developers/Concepts/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 1,
"label": "Concepts"
}
4 changes: 4 additions & 0 deletions docs/developers/HowTo/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 1,
"label": "How To"
}
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 4
title: AVS Operator Set and Slashing of Unique Stake
title: Implement Slashing of Unique Stake
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 8
title: Permissionless Token Strategies
sidebar_position: 7
title: Add ERC-20 Tokens as Restakable Asset
---

# Permissionless Token Strategies
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 9
title: Preparing for Testnet and Mainnet Deployment
sidebar_position: 6
title: Prepare for and Deploy to Testnet and Mainnet
---


Expand All @@ -15,13 +15,13 @@ title: Preparing for Testnet and Mainnet Deployment
- Communication channels that will be utilized for AVS upgrades.
- Describe Operator monitoring tooling available, such as GraFana dashboards, log files or similar.

3. Follow the [AVS Developer Security Best Practices](./avs-developer-best-practices.md) and [Key Manage Considerations for Developers](./avs-developer-best-practices.md#key-management-recommendation-for-developers).
3. Follow the [AVS Developer Security Best Practices](../Reference/avs-developer-best-practices.md) and [Key Manage Considerations for Developers](../Reference/avs-developer-best-practices.md#key-management-recommendation-for-developers).

4. Implement the [Node Specification](https://docs.eigenlayer.xyz/eigenlayer/avs-guides/spec/intro) for your Operator executable package.

5. Follow the [Testnet Dashboard Onboarding instructions](https://docs.eigenlayer.xyz/eigenlayer/avs-guides/avs-dashboard-onboarding).

6. Implement Rewards distributions per the instructions [here](./rewards.md).
6. Implement Rewards distributions per the instructions [here](rewards.md).


## Preparing and Deploying to Mainnet
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
sidebar_position: 3
sidebar_position: 2
title: Build Your Own AVS
---

This section will walk you through the process of designing and building your own AVS from scratch. It is intended to take you from an idea to a working local prototype.

Before proceeding, please review the previous sections on [AVS Overview](./avs-developer-guide.md), [EigenLayer Overview](/docs/eigenlayer/overview/README.md) and the [Quick Start example](./quickstart.md) to become familiar with the basic concepts.
Before proceeding, please review the previous sections on [AVS Overview](../Concepts/avs-developer-guide.md), [EigenLayer Overview](/docs/eigenlayer/overview/README.md) and the [Quick Start example](quickstart.md) to become familiar with the basic concepts.


## Step 1: AVS Design
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 7
title: AVS Dashboard Onboarding
sidebar_position: 5
title: Onboard to AVS Dashboard
---


Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 2
title: Quick Start Example
sidebar_position: 1
title: Get started
---

## Hello World AVS: Local Deployment
Expand Down Expand Up @@ -84,7 +84,7 @@ function respondToTask(
}
```

Please find a complete list of the requirements to implement an AVS at [Build Your Own AVS: Step 2 Idea to Code](/docs/developers/how-to-build-an-avs.md#step-2-idea-to-code-building-and-deploying-your-avs-locally).
Please find a complete list of the requirements to implement an AVS at [Build Your Own AVS: Step 2 Idea to Code](/docs/developers/HowTo/how-to-build-an-avs.md#step-2-idea-to-code-building-and-deploying-your-avs-locally).

### Contract Deployment Scripts

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 8
title: AVS Rewards
sidebar_position: 3
title: Implement Rewards
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 4
title: Developer Support
sidebar_position: 8
title: Get Support
---

If you have any questions or comments throughout the AVS development process, you can get support by reaching out to us using the Intercom button on the bottom right side of this page or <a href="javascript:void(0)" id="intercom_trigger_eldocs" >clicking here</a>. We will promptly follow up with support!
4 changes: 4 additions & 0 deletions docs/developers/Reference/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 1,
"label": "Reference"
}
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/eigenlayer/overview/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ To learn more about EigenLayer please read the [**Whitepaper**](/pdf/EigenLayer_
Get started with EigenLayer:
- [Restake on EigenLayer](/eigenlayer/restaking-guides/overview)
- [Register as an Operator](/eigenlayer/operator-guides/operator-installation)
- [Build an AVS](/developers/avs-developer-guide)
- [Build an AVS](/developers/Concepts/avs-developer-guide)
- Join our Ecosystem: [Discord](https://discord.com/invite/eigenlayer), [Twitter](https://twitter.com/eigenlayer)

2 changes: 1 addition & 1 deletion docs/eigenlayer/resources/learning-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ title: Learning Resources

### Developer resources

Please see Developer Learning Resources [here](/docs/developers/resources.md).
Please see Developer Learning Resources [here](/docs/developers/Reference/resources.md).

### Community

Expand Down
2 changes: 1 addition & 1 deletion docs/eigenlayer/restaking-guides/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Restaking Overview

## **Liquid & Native Restaking**

**Liquid restaking** is the process of depositing "liquid" tokens, including LSTs, EIGEN token, and any ERC20 token into the EigenLayer smart contracts. For more information about adding new ERC20 tokens, please see [Permissionless Token Strategies](/docs/developers/avs-permissionlesss.md).
**Liquid restaking** is the process of depositing "liquid" tokens, including LSTs, EIGEN token, and any ERC20 token into the EigenLayer smart contracts. For more information about adding new ERC20 tokens, please see [Permissionless Token Strategies](/docs/developers/HowTo/avs-permissionlesss.md).


**Native restaking** is the process of changing an Ethereum validator's[ withdrawal credentials](https://notes.ethereum.org/@launchpad/withdrawals-faq#Q-What-are-withdrawals) to EigenLayer's smart contracts. You must operate an Ethereum Validator node in order to participate in Native Restaking. To learn more or set up your Ethereum Validator please follow this link from the[ Ethereum Foundation](https://launchpad.ethereum.org/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,4 @@ Rewards are calculated via an off-chain process. A Merkle root is posted which r


## AVS Integrations
Please refer to [AVS Guide: AVS Rewards](/docs/developers/rewards.md) for complete instructions.
Please refer to [AVS Guide: AVS Rewards](/docs/developers/HowTo/rewards.md) for complete instructions.
56 changes: 50 additions & 6 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,7 @@ const config = {
to: "/eigenlayer/operator-guides/operator-faq",
},

{
from: "/eigenlayer/avs-guides/avs-development-guide",
to: "/developers/how-to-build-an-avs",
},


{
from: "/eigenlayer/restaking-guides/restaking-user-guide/testnet/rewards-claiming/rewards-claiming-instructions",
Expand Down Expand Up @@ -131,11 +128,58 @@ const config = {
from: "/eigenlayer/restaking-guides/restaking-user-guide/testnet/obtaining-testnet-eth-and-liquid-staking-tokens-lsts",
to: "/eigenlayer/restaking-guides/testnet/obtaining-testnet-eth-and-liquid-staking-tokens-lsts",
},
{
from: "/developers",
to: "/developers/Concepts/avs-developer-guide",
},
{
from: "/eigenlayer/economy/economy-overview",
to: "/eigenlayer/economy/economy-calculation-and-formulas",
},

{
from: "/developers/avs-developer-guide",
to: "/developers/Concepts/avs-developer-guide",
},
{
from: "/developers/avs-developer-best-practices",
to: "/developers/Reference/avs-developer-best-practices",
},
{
from: "/developers/avs-opset-slashing",
to: "/developers/HowTo/avs-opset-slashing",
},
{
from: "/developers/avs-permissionlesss",
to: "/developers/HowTo/avs-permissionlesss",
},
{
from: "/developers/deployment-testnet-mainnet",
to: "/developers/HowTo/deployment-testnet-mainnet",
},
{
from: "/developers/how-to-build-an-avs",
to: "/developers/HowTo/how-to-build-an-avs",
},
{
from: "/developers/avs-dashboard-onboarding",
to: "/developers/HowTo/onboard-avs-dashboard",
},
{
from: "/developers/rewards",
to: "/developers/HowTo/rewards",
},
{
from: "/developers/support",
to: "/developers/HowTo/support",
},
{
from: "/developers/resources",
to: "/developers/Reference/resources",
},
{
from: "/developers/quickstart",
to: "/developers/HowTo/quickstart",
},
],
createRedirects(existingPath) {

Expand Down Expand Up @@ -209,7 +253,7 @@ const config = {
activeBasePath: 'eigenlayer/',
},
{
to: "developers/avs-developer-guide",
to: "developers/Concepts/avs-developer-guide",
label: "Developers",
position: "left",
activeBasePath: 'developer/',
Expand Down
2 changes: 1 addition & 1 deletion src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ function Home() {


<Card
to="developers/avs-developer-guide"
to="developers/Concepts/avs-developer-guide"
header={{
label:"AVS Developers"
}}
Expand Down