Fix broken internal links and some 404s #1862
Conversation
…ng-dir/subdir/page.md#id)` format where corrected
|
Warning Rate limit exceeded@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 42 seconds before requesting another review. ⌛ 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. 📒 Files selected for processing (1)
WalkthroughThis pull request focuses on comprehensive documentation updates across multiple markdown files in the Celestia documentation repository. The changes primarily involve standardizing link formats, updating URLs, and enhancing guidance for various network interactions, including devnet, testnet, and node setup instructions. The modifications ensure more consistent and accurate navigation through the documentation by using absolute paths and adding file extensions to markdown links. Changes
Possibly related issues
Possibly related PRs
Suggested labels
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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: 2
🧹 Nitpick comments (1)
tutorials/prompt-scavenger.md (1)
82-82: Remove redundant text and improve clarityThe text after the link is redundant as it repeats the same information.
-Visit [OpenAI](https://platform.openai.com/signup) to sign up for an account and generate an API key. -In order to sign up for an account and generate an OpenAI API key. +Visit [OpenAI](https://platform.openai.com/signup) to sign up for an account and generate an API key.🧰 Tools
🪛 LanguageTool
[style] ~82-~82: Consider a shorter alternative to avoid wordiness.
Context: ...for an account and generate an API key. In order to sign up for an account and generate an ...(IN_ORDER_TO_PREMIUM)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
how-to-guides/arabica-devnet.md(0 hunks)how-to-guides/arbitrum-integration.md(1 hunks)how-to-guides/bridge-node.md(2 hunks)how-to-guides/bubs-testnet.md(4 hunks)how-to-guides/full-storage-node.md(2 hunks)how-to-guides/instantiate-testnet.md(1 hunks)how-to-guides/light-node.md(2 hunks)how-to-guides/mainnet.md(1 hunks)how-to-guides/mocha-testnet.md(3 hunks)how-to-guides/multiaccounts.md(1 hunks)how-to-guides/nodes-overview.md(1 hunks)how-to-guides/rollup-stacks.md(1 hunks)how-to-guides/sp1-blobstream-deploy.md(1 hunks)how-to-guides/submit-data.md(1 hunks)how-to-guides/validator-node.md(3 hunks)tutorials/integrate-celestia.md(1 hunks)tutorials/node-tutorial.md(7 hunks)tutorials/prompt-scavenger.md(1 hunks)
💤 Files with no reviewable changes (1)
- how-to-guides/arabica-devnet.md
✅ Files skipped from review due to trivial changes (9)
- how-to-guides/instantiate-testnet.md
- how-to-guides/submit-data.md
- how-to-guides/nodes-overview.md
- how-to-guides/bridge-node.md
- how-to-guides/rollup-stacks.md
- tutorials/node-tutorial.md
- how-to-guides/full-storage-node.md
- how-to-guides/sp1-blobstream-deploy.md
- tutorials/integrate-celestia.md
🧰 Additional context used
🪛 LanguageTool
tutorials/prompt-scavenger.md
[style] ~82-~82: Consider a shorter alternative to avoid wordiness.
Context: ...for an account and generate an API key. In order to sign up for an account and generate an ...
(IN_ORDER_TO_PREMIUM)
how-to-guides/bubs-testnet.md
[grammar] ~12-~12: Two determiners in a row. Choose either “a” or “the”.
Context: ...s Testnet](https://bubstestnet.com/) is a the first OP Stack testnet with Celestia un...
(DT_DT)
🔇 Additional comments (8)
how-to-guides/multiaccounts.md (1)
63-63: LGTM! Link format improvement.The link has been updated to use an absolute path with
.mdextension, which is more reliable and consistent.how-to-guides/bubs-testnet.md (1)
40-40: LGTM! URL updates.The URLs have been updated to their current endpoints, improving documentation accuracy.
Also applies to: 53-53, 57-57, 70-70, 74-74
how-to-guides/light-node.md (1)
93-93: LGTM! Improved link paths.Links have been updated to use absolute paths with
.mdextensions, making them more reliable and consistent with the documentation standards.Also applies to: 117-117
how-to-guides/arbitrum-integration.md (1)
50-50: LGTM! Link format improvement.The link has been updated to include the
.mdextension, maintaining consistency with documentation standards.how-to-guides/mocha-testnet.md (2)
27-28: LGTM! Improved node type links.Links to node type documentation have been updated to include
.mdextensions, improving reliability.
139-151: LGTM! Consistent URL formatting.URLs have been reformatted for better readability and maintainability, while preserving all endpoint information.
Also applies to: 234-241
how-to-guides/validator-node.md (1)
120-120: LGTM! Links updated correctlyThe links to the troubleshooting page and systemd guide have been properly updated with absolute paths and .md extensions.
Also applies to: 141-141
how-to-guides/mainnet.md (1)
124-125: LGTM! Links updated correctlyThe links to the consensus node and validator node guides have been properly updated to include .md extensions.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
how-to-guides/bubs-testnet.md (1)
Line range hint
1-78: Consider adding a status banner for testnet support.Given the uncertainty about the testnet's support status (as noted in previous comments), consider adding a prominent status banner at the top of the document to clearly indicate whether this testnet is:
- Actively maintained and supported
- In maintenance mode (security updates only)
- Deprecated (with migration instructions if applicable)
This will help users make informed decisions before investing time in this testnet.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/bubs-testnet.md(4 hunks)
🔇 Additional comments (3)
how-to-guides/bubs-testnet.md (3)
78-78: LGTM!The conclusion is well-written and appropriate for the documentation.
74-74:⚠️ Potential issueFix typo and verify faucet functionality.
- There's a typo in the text: "Bulbs rollup" should be "Bubs rollup"
- We should verify that the faucet functionality exists on the new URL
-To visit the Bubs testnet faucet, go to <https://bubstestnet.com/> and click the "Request Faucet Funds on Bulbs rollup" button. +To visit the Bubs testnet faucet, go to <https://bubstestnet.com/> and click the "Request Faucet Funds on Bubs rollup" button.✅ Verification successful
Fix typo: "Bulbs rollup" should be "Bubs rollup"
The faucet functionality exists at the specified URL with the correct button text "Request Faucet Funds on Bubs rollup".
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check if the faucet page exists and contains the button text echo "Checking faucet page..." curl -s https://bubstestnet.com/ | grep -i "Request Faucet Funds"Length of output: 7591
12-12: Verify the authenticity of the Bubs testnet URL and its current status.Given that this is official documentation for a testnet, we should ensure that:
- The URL
https://bubstestnet.com/is the official and secure endpoint- The Bubs testnet is still actively supported
Let's verify the domain ownership and SSL certificate:
✅ Verification successful
The bubstestnet.com URL appears to be legitimate and actively used
The URL is consistently referenced across multiple documentation files and is properly integrated with the Caldera/OP Stack ecosystem. The domain has a valid SSL certificate and is used for both the main testnet interface and faucet functionality.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check domain registration and SSL certificate details # Check SSL certificate echo "Checking SSL certificate for bubstestnet.com..." curl -vI https://bubstestnet.com 2>&1 | grep "SSL certificate" # Check domain registration date echo "Checking domain registration..." whois bubstestnet.com | grep -E "Creation Date|Registrar|Name Server"Length of output: 436
Script:
#!/bin/bash # Search for references to bubstestnet.com and related terms echo "Searching for bubstestnet.com references..." rg -i "bubstestnet" --type md --type txt --type yaml --type json echo -e "\nSearching for bubs testnet configuration..." fd -e yaml -e json -e md -e txt | xargs grep -l -i "bubs.*testnet" echo -e "\nSearching for alternative testnet URLs..." rg -i "testnet.*\.com" --type md --type txt --type yaml --type jsonLength of output: 2943
Co-authored-by: Nuke 🌄 <[email protected]>
There was a problem hiding this comment.
overall LGTM, thank you @nuke-web3
- turn bubs page into historical archive i.e. "this testnet is no longer active"
- add in the new guidance for file paths into the README
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
35-40: Consider enhancing the guidelines with additional examples and tools.To make the guidelines more robust, consider adding:
- A note about avoiding relative paths (e.g.,
../or./)- Examples of incorrect link formats to avoid
- A mention of the lychee tool for link validation
### Link Format Guidelines When adding internal links to documentation, please use the following format: `[link text](/base-working-dir/subdir/page.md#section-id)`, i.e. `[link text](/how-to-guides/quick-start.md#get-your-auth-token)` This format ensures long-term compatibility and consistent behavior across different platforms and documentation builds. + +#### Important Notes +- Always use absolute paths from the repository root (starting with `/`) +- Avoid relative paths (e.g., `../` or `./`) as they can break when files are moved +- Include the `.md` extension in all internal links + +#### Examples to Avoid +❌ `[incorrect](../quick-start)` +❌ `[incorrect](./quick-start.md)` +❌ `[incorrect](quick-start)` +✅ `[correct](/how-to-guides/quick-start.md)` + +#### Validation +You can use [lychee](https://lychee.cli.rs/) to check for broken links in your changes before submitting a PR.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🔇 Additional comments (1)
README.md (1)
35-40: LGTM! Clear and well-structured link format guidelines.The new section effectively establishes a standard format for internal links, which will help prevent broken links in the future. The example and rationale are clear and helpful.
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
how-to-guides/bubs-testnet.md (1)
Line range hint
29-40: Update tense for consistency with archive status.This section still uses present tense which contradicts the historical nature established in other sections.
Apply these changes:
-Bubs Testnet provides a robust environment for developers to test their -Ethereum Virtual Machine (EVM) applications. It offers an EVM-compatible -execution layer, making it an ideal platform for developers looking to -build and test applications in a setting that closely mirrors an OP Stack -rollup on Celestia. +Bubs Testnet provided a robust environment for developers to test their +Ethereum Virtual Machine (EVM) applications. It offered an EVM-compatible +execution layer, making it an ideal platform for developers looking to +build and test applications in a setting that closely mirrored an OP Stack +rollup on Celestia.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/bubs-testnet.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/bubs-testnet.md
[grammar] ~14-~14: Did you mean “are” or “were”?
Context: ...) with support from Celestia Labs. Bubs was dedicated to providing developers with ...
(SENT_START_NNS_IS)
🔇 Additional comments (1)
how-to-guides/bubs-testnet.md (1)
12-14: LGTM! Appropriate tense changes for historical context.The text correctly reflects the historical nature of the Bubs testnet.
🧰 Tools
🪛 LanguageTool
[grammar] ~14-~14: Did you mean “are” or “were”?
Context: ...) with support from Celestia Labs. Bubs was dedicated to providing developers with ...(SENT_START_NNS_IS)
Getting familiar with the docs, I found a few broken links using https://lychee.cli.rs/ and fixed what I could that seemed obvious.
If you like this, see #1863 🙏
Summary by CodeRabbit
Summary by CodeRabbit
Based on the comprehensive summary, here are the release notes:
Documentation Updates
New Features
VerifyAttestationmethod in Arbitrum node software for checking data root postings.Improvements
These updates focus on improving documentation clarity, link reliability, and providing more comprehensive guidance for developers interacting with Celestia's ecosystem.