Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(web): broken links on homepage resolving issue #384 #385

Merged
merged 1 commit into from
Nov 18, 2024
+3 −3
Merged

fix(web): broken links on homepage resolving issue #384 #385

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions web/src/content/docs/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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/installation to /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

</Card>
<Card title="Check the Rules" icon="add-document">
Check each rules to see what is allowed and what is not. See [the
rules](/commitlint-rs/guide/rules) for more information.
rules](/commitlint-rs/rules/body-empty) for more information.
</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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ 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.

Suggested change
rules](/commitlint-rs/rules/body-empty) for more information.
configuration](/commitlint-rs/guides/configuration) for more information.

</Card>
<Card title="Report issues" icon="error">
Report issues to the [GitHub
Expand Down
Loading