fix(web): broken links on homepage resolving issue #384 #385
Conversation
WalkthroughThe changes involve updates to 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: 2
🧹 Outside diff range and nitpick comments (2)
web/src/content/docs/index.mdx (2)
34-34: Consider linking to rules overview instead of specific ruleThe link now points to a specific rule (
body-empty) rather than the rules overview page. This might not provide the best user experience for new users who want to browse all available rules first.Consider linking to a rules index or overview page instead:
- rules](/commitlint-rs/rules/body-empty) for more information. + rules](/commitlint-rs/rules) for more information.
30-38: Consider implementing a clearer documentation structureThe current link updates fix the broken links but could benefit from a more intuitive documentation structure:
- Installation/Setup guide for getting started
- Rules overview page listing all available rules
- Dedicated configuration guide for customization
This would create a more natural flow for users: install → understand rules → customize.
| </Card> | ||
| <Card title="Customize your rules" icon="setting"> | ||
| Edit commitlint configurations to customize your rules. See [the | ||
| rules](/commitlint-rs/guide/rules) for more information. | ||
| rules](/commitlint-rs/rules/body-empty) for more information. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Link doesn't match the card's context
The "Customize your rules" card should ideally point to documentation about rule configuration rather than a specific rule definition. This would better align with the card's purpose of helping users customize their commitlint configuration.
Consider updating the link to point to configuration documentation:
- rules](/commitlint-rs/rules/body-empty) for more information.
+ configuration](/commitlint-rs/guides/configuration) for more information.📝 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.
| rules](/commitlint-rs/rules/body-empty) for more information. | |
| configuration](/commitlint-rs/guides/configuration) for more information. |
| @@ -27,15 +27,15 @@ import { Card, CardGrid } from "@astrojs/starlight/components"; | |||
| </Card> | |||
| <Card title="Run the lint" icon="rocket"> | |||
| Run `commitlint` to lint your commit messages. See [the | |||
| guides](/commitlint-rs/guides/cli) about the CLI. | |||
| guides](/commitlint-rs/setup/installation) about the CLI. | |||
There was a problem hiding this comment.
💡 Codebase verification
The link path in the documentation is incorrect
The link /commitlint-rs/setup/installation is incorrect as the actual documentation file is located at /commitlint-rs/setup/install. This needs to be updated to match the existing file structure.
- In
web/src/content/docs/index.mdx, line 30: Change/commitlint-rs/setup/installationto/commitlint-rs/setup/install
🔗 Analysis chain
Verify the new installation guide path
The link has been updated from CLI guides to installation documentation. Let's verify that this new path exists and is the intended destination.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check if the new installation guide path exists in the documentation
# and if there are any references to the old CLI guide path
# Check for the existence of the new installation guide
fd -e mdx -e md "installation.mdx?" "web/src/content/docs/setup"
# Check if there are any remaining references to the old CLI guide path
rg -l "guides/cli" "web/src/content/docs"
Length of output: 104
Script:
#!/bin/bash
# Let's try a broader search to understand the documentation structure
# Find all MDX/MD files in the docs directory
fd -e mdx -e md . "web/src/content/docs"
# Search for any files containing "installation" in their content
rg -l "installation" "web/src/content/docs"
# Search for any files containing "cli" in their content
rg -l "cli" "web/src/content/docs"
Length of output: 1681
Script:
#!/bin/bash
# Let's check the actual content of the installation-related files and index.mdx
# Check the content of install.md
cat "web/src/content/docs/setup/install.md"
# Check the content of index.mdx to see the context of links
cat "web/src/content/docs/index.mdx"
Length of output: 2441
KeisukeYamashita
merged commit e63130c
into
KeisukeYamashita:main
This resolves issue #384 fixing the broken links.
Summary by CodeRabbit