fix: updated broken links in custom-bridge.mdx#1006
fix: updated broken links in custom-bridge.mdx#1006intls wants to merge 1 commit intoethereum-optimism:mainfrom intls:Broken-links
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe changes in this pull request involve updating the links in the "Custom Bridges" documentation to correctly reference the "Standard Bridge" guide by including the Changes
Possibly related issues
Possibly related PRs
Suggested reviewers
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
Documentation and Community
|
![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
🧹 Outside diff range and nitpick comments (2)
pages/builders/app-developers/bridging/custom-bridge.mdx (2)
11-11: Approve link update with a minor suggestion.The update to include the
.mdxfile extension in the link to the Standard Bridge guide is correct and improves the documentation's accuracy. Well done!For consistency, consider updating the link in the Callout section below (around line 18) to also include the
.mdxextension.
Line range hint
1-54: Overall adherence to coding guidelines with a minor suggestion.The document adheres well to the provided coding guidelines. It uses proper nouns appropriately, maintains gender-neutral language, and follows the correct capitalization rules for headers and proper nouns. The spelling and grammar are correct throughout.
To further improve consistency:
Update the link in the Callout section (around line 18) to include the
.mdxextension:-[Standard Bridge](./standard-bridge) +[Standard Bridge](./standard-bridge.mdx)Consider updating the links in the "Next Steps" section to use relative paths with
.mdxextensions if they refer to local documentation files.These changes will ensure uniform link formatting throughout the document.
🧰 Tools
🪛 LanguageTool
[style] ~13-~13: To make your writing concise, consider an alternative.
Context: ...ovides important information you should be aware of when building a custom bridge. <Callou...(AWARE_OF)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- pages/builders/app-developers/bridging/custom-bridge.mdx (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/app-developers/bridging/custom-bridge.mdx (1)
Pattern
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🔇 Additional comments (1)
pages/builders/app-developers/bridging/custom-bridge.mdx (1)
30-30: Approve link update.The update to include the
.mdxfile extension in the link to the "Using the Standard Bridge" guide is correct and improves the documentation's accuracy. Good job on maintaining consistency with the previous link update!
krofax
left a comment
krofax
left a comment
There was a problem hiding this comment.
This works well, i'm not sure we need to add .mdx to the files
|
Closing this PR |
Hi @krofax This 2 links really does not work! It shows 404 - page not found
|
2 participants
Description
I have updated the custom-bridge.mdx file to fix an issue where the “Standard Bridge” link was styled as a hyperlink but had no valid destination. I replaced the broken link with the correct relative path to the standard-bridge.mdx file, ensuring users can now navigate properly within the documentation.
Tests
No additional tests were added, as this change affects documentation formatting. The updated link has been manually tested to confirm it correctly navigates to the standard-bridge.mdx file.
Additional context
The issue was identified during a review of internal documentation links. This change improves the usability and accuracy of the documentation by ensuring that links between relevant sections are functional.
Metadata
Fixes #1005