feat: new guides structure #764
Conversation
|
|
||
| ## Tests setup configuration | ||
|
|
||
| Tests setup based upon parameters specified in [this config file](https://github.com/lidofinance/scripts/blob/master/configs/config_mainnet.py) . This document can be used to validate the values. |
There was a problem hiding this comment.
| Tests setup based upon parameters specified in [this config file](https://github.com/lidofinance/scripts/blob/master/configs/config_mainnet.py). This document can be used to validate the values. |
| @@ -1,4 +1,4 @@ | |||
| # stETH on Optimism parameters for Mainnet | |||
| # stETH on Optimism parameters | |||
There was a problem hiding this comment.
| # stETH on Optimism parameters | |
| # stETH on Optimism parameters validation |
| @@ -1,4 +1,4 @@ | |||
| # Identifying Shadow Owners in Safe Multisig | |||
| # Shadow Owner Detection in Safe | |||
There was a problem hiding this comment.
Pull request overview
This PR implements a new organizational structure for documentation guides by grouping related content into logical categories and standardizing guide titles for improved navigation and consistency.
Key Changes:
- Reorganized guides into three new categories: "Governance and Voting", "Multisig Operations", and "Archived"
- Standardized guide titles to be more concise and consistent across the documentation
- Moved deprecated guides (multisig-deployment, checking-aragon-vote) into an "Archived" section
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Restructured guides section with new categories (Governance and Voting, Multisig Operations, Archived) and reorganized guide ordering |
| docs/guides/verify-steth-on-optimism-upgrade-manual.md | Updated title from "stETH on Optimism parameters for Mainnet" to "stETH on Optimism parameters" |
| docs/guides/verify-lido-v2-upgrade-manual.md | Updated title from "Lido V2 mainnet parameters" to "Lido V2 mainnet parameters validation" |
| docs/guides/multisig-signer-manual.md | Shortened title from "Guide to being a signer at any Lido DAO multisigs" to "Multisig Signer Guide" |
| docs/guides/multisig-shadow-owners.md | Updated title from "Identifying Shadow Owners in Safe Multisig" to "Shadow Owner Detection in Safe" |
| docs/guides/jumpgates.md | Shortened title from "How to Bridge Tokens through Jumpgate" to "Bridge Tokens via Jumpgate" |
| docs/guides/early-staker-airdrop.md | Updated title from "How to claim Lido early stakers airdrop" to "Lido Early Stakers Airdrop Claim" |
| docs/guides/checking-gnosis-safe.md | Shortened title from "How to verify the multisig is a Gnosis one" to "Gnosis Multisig Verification" |
| docs/guides/checking-aragon-vote.md | Updated title from "Checking the evm script from Aragon vote" to "Aragon vote: checking the evm script" |
| docs/guides/address-ownership-guide.md | Updated title from "Verifying address ownership for Lido DAO operational multisigs" to "Multisig Signer Address Verification" |
| docs/guides/1inch-pool-rewards.md | Shortened title from "How to claim 1inch stETH/LDO pool rewards" to "1inch Rewards Claim" |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,4 +1,4 @@ | |||
| # Lido V2 mainnet parameters | |||
| # Lido V2 mainnet parameters validation | |||
There was a problem hiding this comment.
The title change adds "validation" but the guide appears to be about "parameters" verification. Consider whether "Lido V2 Mainnet Parameters Verification" would be more accurate and consistent with similar guides like "Multisig Signer Address Verification".
| # Lido V2 mainnet parameters validation | |
| # Lido V2 Mainnet Parameters Verification |
| @@ -1,4 +1,4 @@ | |||
| # stETH on Optimism parameters for Mainnet | |||
| # stETH on Optimism parameters | |||
There was a problem hiding this comment.
The shortened title "stETH on Optimism parameters" is less clear about what the document covers compared to the original. Consider a more descriptive title like "stETH on Optimism Upgrade Parameters" or "stETH on Optimism Deployment Parameters" to clarify the guide's purpose.
| # stETH on Optimism parameters | |
| # stETH on Optimism Upgrade Parameters |
| @@ -1,4 +1,4 @@ | |||
| # How to claim 1inch stETH/LDO pool rewards | |||
| # 1inch Rewards Claim | |||
There was a problem hiding this comment.
The title "1inch Rewards Claim" is ambiguous as it doesn't specify what rewards or pool is being claimed. Consider a more descriptive title like "1inch stETH/LDO Pool Rewards Claim" to match the specificity of the document content.
| # 1inch Rewards Claim | |
| # 1inch stETH/LDO Pool Rewards Claim |
Please, go through these steps before you request a review:
📝 Describe your changes
🔎 Attach a source of truth or evidence that allows reviewers to confirm the changes independently