Fixing Broken links #1191
Fixing Broken links #1191
Conversation
Fixing borken links
WalkthroughThe pull request involves updates to the Changes
Possibly related PRs
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
🧹 Outside diff range and nitpick comments (1)
README.md (1)
48-52: Maintain consistent list style markers.For better markdown consistency, replace asterisks with dashes in the unordered list.
Apply this diff:
-* Check out our [contributions guide](https://docs.omi.me/docs/developer/Contribution/). -* Check out the [current tasks](https://github.com/BasedHardware/Omi/issues). -* Earn from contributing! Check the [paid bounties 🤑](https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue+label:%22Paid+Bounty+%F0%9F%92%B0%22). -* Join the [Discord](https://discord.gg/omi). -* Build your own [Plugins/Integrations](https://docs.omi.me/docs/developer/apps/Introduction). +- Check out our [contributions guide](https://docs.omi.me/docs/developer/Contribution/). +- Check out the [current tasks](https://github.com/BasedHardware/Omi/issues). +- Earn from contributing! Check the [paid bounties 🤑](https://github.com/BasedHardware/Omi/issues?q=is:open+is:issue+label:%22Paid+Bounty+%F0%9F%92%B0%22). +- Join the [Discord](https://discord.gg/omi). +- Build your own [Plugins/Integrations](https://docs.omi.me/docs/developer/apps/Introduction).🧰 Tools
🪛 Markdownlint
48-48: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
49-49: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
50-50: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
51-51: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
52-52: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- README.md (1 hunks)
- docs/docs/assembly/Build_the_device.mdx (1 hunks)
🧰 Additional context used
🪛 Markdownlint
README.md
48-48: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
49-49: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
50-50: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
51-51: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
52-52: Expected: dash; Actual: asterisk
Unordered list style(MD004, ul-style)
🔇 Additional comments (3)
docs/docs/assembly/Build_the_device.mdx (1)
20-20:⚠️ Potential issueUpdate the hardware repository path to reflect rebranding.
The GitHub repository path still references "Friend" instead of "Omi" in the hardware directory structure. This should be updated for consistency with the rebranding.
-Download and print the case from the provided .stl file [link](https://github.com/BasedHardware/omi/tree/main/Friend/hardware/triangle%20v1). +Download and print the case from the provided .stl file [link](https://github.com/BasedHardware/omi/tree/main/Omi/hardware/triangle%20v1).Let's verify if this repository path exists and if there are any other occurrences:
README.md (2)
40-44: Verify all updated documentation paths exist.Let's ensure all the updated documentation paths with the new
/docs/prefix are valid.#!/bin/bash # Description: Verify all updated documentation paths exist # Test: Check if the documentation files exist in the new structure echo "Checking documentation files..." fd -e mdx -e md "Setup.mdx\|Setup.md\|Buying_Guide.mdx\|Buying_Guide.md\|Build_the_device.mdx\|Build_the_device.md\|Flash_device.mdx\|Flash_device.md\|Introduction.mdx\|Introduction.md" docs/
43-43: Verify the new firmware installation path exists.The firmware installation link has been significantly changed from
/assembly/Install_firmware/to/get_started/Flash_device/. Let's verify this new path is valid and accessible.✅ Verification successful
Let me try another verification approach to check for any documentation files related to firmware or flashing in the repository.
Let me try one final verification to specifically check the content in the get_started directory since that's where the new link points to:
The firmware installation link is valid and correctly updated
The new path
/docs/get_started/Flash_device/exists in the repository atdocs/docs/get_started/Flash_device.mdx, confirming that the documentation link update is correct and points to an existing resource.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the new firmware installation documentation exists # Test: Check if the new firmware documentation file exists fd -e mdx -e md "Flash_device.mdx\|Flash_device.md" docs/Length of output: 266
Script:
#!/bin/bash # Search for any documentation files containing firmware or flash-related content echo "Searching for firmware/flash-related documentation..." rg -i "firmware|flash" --type md --type mdx # Also check if there might be alternative paths in the docs echo -e "\nChecking docs directory structure..." fd . docs/ -t dLength of output: 750
Script:
#!/bin/bash # Check contents of get_started directory echo "Checking get_started directory contents..." fd . docs/docs/get_started/ -t f # Try searching with ripgrep without mdx extension echo -e "\nSearching for firmware/flash content in markdown files..." rg -i "firmware|flash" -t markdownLength of output: 2116
| @@ -13,11 +13,11 @@ If you received an unassembled Omi or want to build one yourself, follow the ste | |||
|
|
|||
| **Step 0.** Components | |||
|
|
|||
| Ensure you've purchased all required components from the [buying guide](https://docs.omi.me/assembly/Buying_Guide/)) | |||
| Ensure you've purchased all required components from the [buying guide](https://docs.omi.me/docs/assembly/Buying_Guide)) | |||
There was a problem hiding this comment.
Fix the syntax error in the buying guide link.
There's an extra closing parenthesis in the Markdown link.
-Ensure you've purchased all required components from the [buying guide](https://docs.omi.me/docs/assembly/Buying_Guide))
+Ensure you've purchased all required components from the [buying guide](https://docs.omi.me/docs/assembly/Buying_Guide)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Ensure you've purchased all required components from the [buying guide](https://docs.omi.me/docs/assembly/Buying_Guide)) | |
| Ensure you've purchased all required components from the [buying guide](https://docs.omi.me/docs/assembly/Buying_Guide) |
|
|
||
| [//]: # (- [Support](https://docs.omi.me/info/Support/)) | ||
| [//]: # (- [Support](https://docs.omi.me/docs/info/Support/;) |
There was a problem hiding this comment.
Fix markdown link syntax error.
There's a syntax error in the commented Support link where a semicolon is used instead of a closing parenthesis.
Apply this diff:
-[//]: # (- [Support](https://docs.omi.me/docs/info/Support/;)
+[//]: # (- [Support](https://docs.omi.me/docs/info/Support/))📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [//]: # (- [Support](https://docs.omi.me/docs/info/Support/;) | |
| [//]: # (- [Support](https://docs.omi.me/docs/info/Support/)) |
Summary by CodeRabbit
README.mdfile with new links and improved clarity, including rebranding from "Friend" to "Omi."