docs: fix broken link on docs page

[mpoke]

Description

Closes: #XXXX

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct docs: prefix in the PR title
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• Confirmed the correct docs: prefix in the PR title
• Confirmed all author checklist items have been addressed
• Confirmed that this PR only changes documentation
• Reviewed content for consistency
• Reviewed content for spelling and grammar
• Tested instructions (if applicable)
• Checked that the documentation website can be built and deployed successfully (run make build-docs)

Summary by CodeRabbit

• Documentation
  • Updated the link to the ADR template in intro.md to point to a new location on GitHub.

[coderabbitai]

Walkthrough

Walkthrough

The main change entails updating the link to the Architectural Decision Record (ADR) template in the intro.md file to a new, accurate location within a GitHub repository. This ensures that references to the ADR template are correctly redirected, enhancing documentation accuracy and user navigation.

Changes

File	Change Summary
docs/docs/adrs/intro.md	Updated the link in the ADR suggestion section from ./templates/adr-template.md to https://github.com/cosmos/interchain-security/blob/main/docs/docs/adrs/templates/adr-template.md.

---

Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 25f3132 and 7505d3e.

Files selected for processing (1)

• docs/docs/adrs/intro.md (1 hunks)

Additional context used

Path-based instructions (1)

docs/docs/adrs/intro.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness. Please DO NOT report any missing or superfluous newlines, in particular at the end or beginning of files."

LanguageTool

docs/docs/adrs/intro.md

[uncategorized] ~26-~26: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...re, and then modify the code to match. Note the context/background should be writte...

Markdownlint

docs/docs/adrs/intro.md

6-6: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document

Additional comments not posted (2)

docs/docs/adrs/intro.md (2)

29-29: Approved link update for better accessibility and reliability.

The update from a relative path to an absolute URL ensures that the link remains accessible regardless of where the document is viewed from, which is particularly useful in a distributed documentation system like GitHub.

---

26-26: Consider adding a comma for clarity.

Adding a comma after "match" could improve the readability of the sentence, helping to separate the distinct ideas more clearly.

- ...modify the code to match. Note the context...
+ ...modify the code to match, Note the context...

Tools

LanguageTool

[uncategorized] ~26-~26: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...re, and then modify the code to match. Note the context/background should be writte...

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

docs/docs/adrs/intro.md (1)

Line range hint 6-6: Consider restructuring to avoid multiple top-level headings.

Using multiple top-level headings (#) can be confusing and does not follow best practices for Markdown file structure. Consider using secondary headings (##) for major sections after the first.

- # Overview
+ ## Overview

Tools

LanguageTool

[uncategorized] ~26-~26: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...re, and then modify the code to match. Note the context/background should be writte...

[insumity]

🤔 This link does not seem broken when going [https://github.com/cosmos/interchain-security/blob/main/docs/docs/adrs/intro.md] here by clicking on it. Not sure if I'm missing something but we seem to use the ./dir1/... extensively in our docs with no issues.

[mpoke]

The template is not render on the docs site. That's why it needs to be a github link.