fix broken links in README_EN.md #1060
Conversation
|
Hi @phosae, welcome to SOFAStack community, Please sign Contributor License Agreement! After you signed CLA, we will automatically sync the status of this pull request in 3 minutes. |
sofastack-cla
bot
added
bug
WalkthroughThe pull request updates the README_EN.md file by replacing relative project references with direct GitHub repository links for two sample projects. These changes enhance documentation navigation by providing explicit URLs to the README files for the "Ark Plugin Based On Maven Project" and "Ark Based On Spring Boot" sample projects, making it easier for users to access detailed project information directly from the main documentation. 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: 0
🧹 Nitpick comments (2)
README_EN.md (2)
47-48: Consider improving markdown formatting.The markdown formatting could be improved to follow the standard style guide:
- * [Ark Plugin Based On Maven Project](https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-plugin/README_EN.md) - Sample Project for Ark-Plugin - * [Ark Based On Spring Boot](https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-springboot/README_EN.md) - Sample Project for Ark based on Spring Boot Project + + [Ark Plugin Based On Maven Project](https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-plugin/README_EN.md) - Sample Project for Ark-Plugin + + [Ark Based On Spring Boot](https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-springboot/README_EN.md) - Sample Project for Ark based on Spring Boot Project🧰 Tools
🪛 Markdownlint (0.37.0)
47-47: Expected: plus; Actual: asterisk
Unordered list style(MD004, ul-style)
48-48: Expected: plus; Actual: asterisk
Unordered list style(MD004, ul-style)
47-47: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
48-48: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
47-48: Consider adding version information to the sample links.To help users find the appropriate sample for their version, consider adding version tags to the URLs or mentioning the compatible versions in the descriptions.
- * [Ark Plugin Based On Maven Project](https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-plugin/README_EN.md) - Sample Project for Ark-Plugin - * [Ark Based On Spring Boot](https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-springboot/README_EN.md) - Sample Project for Ark based on Spring Boot Project + * [Ark Plugin Based On Maven Project](https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-plugin/README_EN.md) - Sample Project for Ark-Plugin (Latest) + * [Ark Based On Spring Boot](https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-springboot/README_EN.md) - Sample Project for Ark based on Spring Boot Project (Latest)🧰 Tools
🪛 Markdownlint (0.37.0)
47-47: Expected: plus; Actual: asterisk
Unordered list style(MD004, ul-style)
48-48: Expected: plus; Actual: asterisk
Unordered list style(MD004, ul-style)
47-47: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
48-48: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README_EN.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README_EN.md
47-47: Expected: plus; Actual: asterisk
Unordered list style
(MD004, ul-style)
48-48: Expected: plus; Actual: asterisk
Unordered list style
(MD004, ul-style)
47-47: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
48-48: Expected: 2; Actual: 4
Unordered list indentation
(MD007, ul-indent)
🔇 Additional comments (1)
README_EN.md (1)
47-48: Verify accessibility of the new documentation links.The links have been updated to point to the English documentation in the guides repository. Let's verify these links are accessible and up-to-date.
✅ Verification successful
Documentation links are valid and accessible
Both updated documentation links return HTTP 200 responses, confirming they are correctly pointing to existing resources in the guides repository.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Check if the new documentation links are accessible # and verify they point to existing files # Check both new URLs for url in \ "https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-plugin/README_EN.md" \ "https://github.com/sofastack-guides/sofa-ark-guides/blob/master/sample-ark-springboot/README_EN.md" do echo "Checking $url" curl -s -I "$url" | head -n 1 doneLength of output: 1132
🧰 Tools
🪛 Markdownlint (0.37.0)
47-47: Expected: plus; Actual: asterisk
Unordered list style(MD004, ul-style)
48-48: Expected: plus; Actual: asterisk
Unordered list style(MD004, ul-style)
47-47: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
48-48: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
Summary by CodeRabbit