docs: fix broken Balancer whitepaper links #193
Conversation
WalkthroughThe PR updates documentation references within two modules by replacing the whitepaper URL. Both the Changes
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
precompile/modules/minitia_stdlib/doc/dex.md (2)
1157-1157: Convert bare URL to markdown link for consistency.
The URL on this line is now updated to the correct destination (https://docs.balancer.fi/whitepaper.pdf) but appears as a bare URL. To address markdownlint MD034, consider wrapping it in proper markdown link syntax. For example, you could change the line from:- https://docs.balancer.fi/whitepaper.pdf (2) + [Balancer Whitepaper](https://docs.balancer.fi/whitepaper.pdf) (2)This change improves readability and complies with markdown best practices.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1157-1157: Bare URL used
null(MD034, no-bare-urls)
3001-3001: Convert bare URL to markdown link for compliance.
Similarly, on this line the URL is again a bare URL. To prevent markdownlint MD034 warnings and to enhance document consistency, consider switching to a markdown link notation. For example:- https://docs.balancer.fi/whitepaper.pdf (15) + [Balancer Whitepaper](https://docs.balancer.fi/whitepaper.pdf) (15)This update will make the documentation more maintainable and align with contribution guidelines.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3001-3001: Bare URL used
null(MD034, no-bare-urls)
precompile/modules/initia_stdlib/doc/dex.md (2)
1157-1157: Updated Balancer Whitepaper Link inget_spot_price:
The URL has been correctly updated tohttps://docs.balancer.fi/whitepaper.pdf, which aligns with the PR objective to fix broken links. Note that the bare URL is triggering a markdownlint MD034 warning; consider using markdown link syntax (e.g.,[Balancer Whitepaper](https://docs.balancer.fi/whitepaper.pdf)) to improve documentation consistency.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
1157-1157: Bare URL used
null(MD034, no-bare-urls)
3001-3001: Updated Balancer Whitepaper Link inswap_simulation:
The new URLhttps://docs.balancer.fi/whitepaper.pdfis correctly applied, ensuring that the documentation now points to a current resource. Similar to the previous comment, you might want to wrap the URL in a markdown link to avoid bare URL warnings (MD034) and enhance readability.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
3001-3001: Bare URL used
null(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
precompile/modules/initia_stdlib/doc/dex.md(2 hunks)precompile/modules/initia_stdlib/sources/dex.move(2 hunks)precompile/modules/minitia_stdlib/doc/dex.md(2 hunks)precompile/modules/minitia_stdlib/sources/dex.move(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
precompile/modules/minitia_stdlib/doc/dex.md
1157-1157: Bare URL used
null
(MD034, no-bare-urls)
3001-3001: Bare URL used
null
(MD034, no-bare-urls)
precompile/modules/initia_stdlib/doc/dex.md
1157-1157: Bare URL used
null
(MD034, no-bare-urls)
3001-3001: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (4)
precompile/modules/initia_stdlib/sources/dex.move (2)
276-277: Documentation Link Update for get_spot_price
The documentation comment in theget_spot_pricefunction now references the updated Balancer whitepaper URL (https://docs.balancer.fi/whitepaper.pdf). This update improves the accuracy of the reference. Please double-check that the appended reference "(2)" correctly corresponds to the intended section in the whitepaper.
1788-1789: Documentation Link Update for swap_simulation
The documentation comment for theswap_simulationfunction has been updated to include the new Balancer whitepaper URL (https://docs.balancer.fi/whitepaper.pdf). Verify that the appended annotation "(15)" accurately points to the corresponding paper section. This change is cosmetic and does not affect functionality.precompile/modules/minitia_stdlib/sources/dex.move (2)
275-277: Documentation Update: Corrected whitepaper URL inget_spot_pricedocumentation.
The comment was updated from the outdated URL tohttps://docs.balancer.fi/whitepaper.pdf(with the reference tag “(2)”), ensuring that users are pointed to the current Balancer whitepaper.
1788-1790: Documentation Update: Corrected whitepaper URL inswap_simulationdocumentation.
The comment now correctly points tohttps://docs.balancer.fi/whitepaper.pdf(tagged as “(15)”), which aligns with the updated references throughout the project.
Description
Hi! I updated outdated links referencing the Balancer whitepaper across multiple filesю
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
Summary by CodeRabbit