fix: fix links to main docs portal #518
Conversation
WalkthroughThe changes in this pull request involve modifications to documentation files, specifically in the Changes
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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
.gitbook/contracts/README.md(1 hunks).gitbook/core-modules/auction.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- .gitbook/contracts/README.md
| @@ -68,7 +68,7 @@ How to use funds that are currently associated with your Injective Address in ba | |||
| - If you have existing non-default subaccounts, you'll want to do a[ MsgDeposit ](exchange.md#msgdeposit)to one of your existing non-default subaccountIds and use that subaccountId as the `srcSubaccountId` below. | |||
| - If you don't have existing non-default subaccounts, you can do a [MsgDeposit](exchange.md#msgdeposit) to a new default subaccountId, which would be done via importing `getSubaccountId` from `sdk-ts` and setting the `subaccountId` field in [MsgDeposit](exchange.md#msgdeposit) to `getSubaccountId(injectiveAddress, 1)`. | |||
|
|
|||
| For more info, check out the [burn auction pool docs](https://docs.injective.network/develop/tech-concepts/auction_pool/). | |||
| For more info, check out the [burn auction pool docs](https://docs.injective.network/developers/modules/injective/auction). | |||
There was a problem hiding this comment.
💡 Codebase verification
Documentation link update verified and additional update needed
The PR correctly updates the burn auction documentation link to https://docs.injective.network/developers/modules/injective/auction. However, there is another outdated link in the same file that needs to be updated:
- Line 71: Updated link to
docs.injective.network✅ - Line 3: Still using old link
https://hub.injective.network/auction/❌
The old hub.injective.network domain should also be updated to the new documentation portal for consistency.
🔗 Analysis chain
Verify the updated documentation link
The link update to https://docs.injective.network/developers/modules/injective/auction aligns with the PR objective of fixing documentation links.
Let's verify the link's validity and consistency:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the documentation link and check for consistency
# Check if this new link format is used consistently across the documentation
# Search for other occurrences of the old and new link patterns
echo "Checking for old link pattern..."
rg -i "hub\.injective\.network/auction"
echo "Checking for new link pattern..."
rg -i "docs\.injective\.network/developers/modules/injective/auction"
# Check if the new domain is used consistently
echo "Checking for consistency in documentation domain..."
rg -i "docs\.injective\.network"
Length of output: 411
Script:
#!/bin/bash
# Let's try a broader search to understand the documentation link patterns
# Check for any references to injective.network domains
echo "Checking for all injective.network domain references..."
rg -i "injective\.network"
# Check for any .md files that might contain documentation links
echo "Finding all markdown files..."
fd -e md
# Check specifically in the .gitbook directory for link patterns
echo "Checking links in .gitbook directory..."
rg -i "http[s]?://" .gitbook/
Length of output: 35551
Script:
#!/bin/bash
# Let's check the specific auction documentation links in the .gitbook directory
echo "Checking auction-related links in .gitbook..."
rg -i "auction" .gitbook/core-modules/auction.md
# Let's also check if there are any other files referencing the old hub.injective.network domain
echo "Checking for other hub.injective.network references..."
rg -i "hub\.injective\.network" .gitbook/
Length of output: 1674
Summary by CodeRabbit