docs(contracts): refresh docs index and normalize API links#1722
Open
Ser4nu11EN7 wants to merge 1 commit intolifinance:mainfrom
Open
docs(contracts): refresh docs index and normalize API links#1722Ser4nu11EN7 wants to merge 1 commit intolifinance:mainfrom
Ser4nu11EN7 wants to merge 1 commit intolifinance:mainfrom
Conversation
Contributor
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 23 minutes and 19 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (9)
WalkthroughDocumentation-only updates across multiple bridge facet files, replacing the API documentation domain from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/README.md (1)
5-96:⚠️ Potential issue | 🟠 MajorFix 10 dead links in docs/README.md.
The following files are referenced but missing from
docs/:
- AmarokFacet.md
- CircleBridgeFacet.md
- HyphenFacet.md
- LIFuelFacet.md
- RoninBridgeFacet.md
- StandardizedCallFacet.md
- StargateFacet.md
- LiFuelFeeCollector.md
- Receiver.md
- RelayerCelerIM.md
Either create these documentation files or remove the broken links from the README.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/README.md` around lines 5 - 96, The README links list contains references to missing docs (entries like "Amarok Facet", "Circle Bridge Facet", "Hyphen Facet", "LIFuel Facet", "Ronin Bridge Facet", "Standardized Call Facet", "Stargate Facet", and periphery entries "LiFuelFeeCollector", "Receiver", "RelayerCelerIM") that cause dead links; to fix, either add the corresponding markdown files to docs/ (e.g., create AmarokFacet.md, CircleBridgeFacet.md, HyphenFacet.md, LIFuelFacet.md, RoninBridgeFacet.md, StandardizedCallFacet.md, StargateFacet.md, LiFuelFeeCollector.md, Receiver.md, RelayerCelerIM.md) with the appropriate content, or remove the matching list items/links from docs/README.md (search for the link labels shown in the README like "Amarok Facet", "Circle Bridge Facet", "Hyphen Facet", "LIFuel Facet", "Ronin Bridge Facet", "Standardized Call Facet", "Stargate Facet", "LiFuelFeeCollector", "Receiver", "RelayerCelerIM" and update accordingly).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/ArbitrumBridgeFacet.md`:
- Line 101: The link text "here" is non-descriptive and fails MD059; update the
anchor at the sentence "A detailed explanation on how to use the /quote endpoint
and how to trigger the transaction can be found
[here](https://apidocs.li.fi/reference/how-to-transfer-tokens)." to use a
descriptive label such as "API docs: How to transfer tokens" or "How to transfer
tokens (Li.Fi API)" so the markdown reads e.g. "...can be found [How to transfer
tokens](https://apidocs.li.fi/reference/how-to-transfer-tokens)." to improve
accessibility and clarity.
In `@docs/CelerCircleBridgeFacet.md`:
- Line 64: Replace the ambiguous link text "here" with an accessible,
descriptive label for the URL pointing to
https://apidocs.li.fi/reference/how-to-transfer-tokens (e.g., "API docs: How to
transfer tokens" or "How to transfer tokens (li.fi API docs)") so the sentence
reads: "A detailed explanation on how to use the /quote endpoint and how to
trigger the transaction can be found [How to transfer tokens (li.fi API
docs)](https://apidocs.li.fi/reference/how-to-transfer-tokens)." Ensure the new
text addresses MD059 by providing meaningful link text.
In `@docs/OptimismBridgeFacet.md`:
- Line 94: The markdown link uses the generic anchor "here" which triggers
MD059; update the anchor to descriptive text such as "How to transfer tokens"
(or "API docs: How to transfer tokens") by replacing the text "[here]" in the
sentence "A detailed explanation ... can be found
[here](https://apidocs.li.fi/reference/how-to-transfer-tokens)" with a
descriptive label so the link becomes e.g. "[How to transfer
tokens](https://apidocs.li.fi/reference/how-to-transfer-tokens)"; keep the URL
unchanged and ensure the new anchor satisfies the markdown linter.
In `@docs/PolygonBridgeFacet.md`:
- Line 64: The link text "here" for the URL
https://apidocs.li.fi/reference/how-to-transfer-tokens (referencing the /quote
endpoint and how to trigger the transaction) is non‑descriptive; update the
Markdown so the link text explicitly describes the target (e.g., "li.fi API docs
– How to transfer tokens" or "How to transfer tokens (li.fi API docs)"),
replacing "here" in the PolygonBridgeFacet.md line that references the /quote
endpoint to satisfy MD059.
---
Outside diff comments:
In `@docs/README.md`:
- Around line 5-96: The README links list contains references to missing docs
(entries like "Amarok Facet", "Circle Bridge Facet", "Hyphen Facet", "LIFuel
Facet", "Ronin Bridge Facet", "Standardized Call Facet", "Stargate Facet", and
periphery entries "LiFuelFeeCollector", "Receiver", "RelayerCelerIM") that cause
dead links; to fix, either add the corresponding markdown files to docs/ (e.g.,
create AmarokFacet.md, CircleBridgeFacet.md, HyphenFacet.md, LIFuelFacet.md,
RoninBridgeFacet.md, StandardizedCallFacet.md, StargateFacet.md,
LiFuelFeeCollector.md, Receiver.md, RelayerCelerIM.md) with the appropriate
content, or remove the matching list items/links from docs/README.md (search for
the link labels shown in the README like "Amarok Facet", "Circle Bridge Facet",
"Hyphen Facet", "LIFuel Facet", "Ronin Bridge Facet", "Standardized Call Facet",
"Stargate Facet", "LiFuelFeeCollector", "Receiver", "RelayerCelerIM" and update
accordingly).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 2541554a-5745-4882-a569-d60399128743
📒 Files selected for processing (9)
docs/ArbitrumBridgeFacet.mddocs/CelerCircleBridgeFacet.mddocs/GnosisBridgeFacet.mddocs/MegaETHBridgeFacet.mddocs/OmniBridgeFacet.mddocs/OptimismBridgeFacet.mddocs/PolygonBridgeFacet.mddocs/README.mddocs/StargateFacetV2.md
Ser4nu11EN7
force-pushed
the
docs/contracts-readme-links
branch
from
7c4f4fe to
8f0fd7d
Compare
Ser4nu11EN7
force-pushed
the
docs/contracts-readme-links
branch
from
8f0fd7d to
e4d2fa5
Compare
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
1 participant
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.
Which Linear task belongs to this PR?
N/A (community contribution)
Why did I implement it this way?
This is a docs-only cleanup. The docs index was out of date, and several references still pointed to the deprecated �pidocs.li.finance hostname. Refreshing the README index and normalizing those links reduces friction for contributors reading the contracts docs.
Checklist before requesting a review
Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)