docs: refresh README as ether.fi's Liquid Staking Protocol Contracts - #502
Merged
Merged
Conversation
Co-Authored-By: Claude <noreply@anthropic.com>
… CLAUDE.md layout Co-Authored-By: Claude <noreply@anthropic.com>
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
This reverts commit 960aa51.
📊 Forge Coverage ReportGenerated by workflow run #829 |
seongyun-ko
previously approved these changes
Sep 23, 2026
seongyun-ko
approved these changes
Sep 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
src/layout, an architecture section, a test directory guide, and a repository layout table.certora/config, previouslycertora/conf).LICENSElink with a pointer to the SPDX headers, since the repo has no LICENSE file.src/module folders and addstest/invariantandcertora/.docs/src/,docs/book.*,docs/solidity.min.js) and the olddocumentation/src/README.md. They described removed contracts and nothing referenced them.Docs only. No contract changes.
🤖 Generated with Claude Code
Note
Low Risk
No Solidity or deployment changes; only markdown and deleted obsolete documentation assets.
Overview
Documentation-only refresh that retitles the repo to ether.fi's Liquid Staking Protocol Contracts and rewrites
README.mdandCLAUDE.mdaround the current modularsrc/layout (core, staking, restaking, withdrawals, governance, etc.), UUPS/timelock/RoleRegistryarchitecture, Foundry/Certora workflows, test directory guide, audit/CI notes, and links to external GitBook deployed addresses.Removes stale in-repo docs: the entire legacy
docs/mdBook tree (old GadzeFinance contract reference pages,book.toml, assets) and duplicatedocumentation/src/README.md, so onboarding relies on the root README and external docs instead of outdated generated API markdown.Reviewed by Cursor Bugbot for commit 3be82e4. Bugbot is set up for automated code reviews on this repo. Configure here.