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.

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

docs: broken link for Algorand announcing rekeying #18266

Merged
merged 1 commit into from
Oct 26, 2023

Conversation

MartinKong1990
Copy link
Contributor

@MartinKong1990 MartinKong1990 commented Oct 26, 2023

Old: https://algorand.com/resources/blog/announcing-rekeying

New: https://algorand.com/resources/algorand-announcements/announcing-rekeying)

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 type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • run make lint and make test
  • 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 type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

Summary by CodeRabbit

  • Documentation: Updated a URL reference in our architecture documentation. This change ensures that users and developers accessing our documentation are directed to the correct and most up-to-date information about account rekeying on Algorand's website.

@MartinKong1990 MartinKong1990 requested a review from a team as a code owner October 26, 2023 08:24
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 26, 2023

Walkthrough

This change is a simple yet crucial update to a URL reference in the documentation. The new URL leads to the same content but on a different page, ensuring that readers can still access the relevant information about account rekeying on Algorand's website.

Changes

File Summary
docs/architecture/.../adr-034-account-rekeying.md Updated the URL reference from "https://www.algorand.com/resources/blog/announcing-rekeying" to "https://algorand.com/resources/algorand-announcements/announcing-rekeying".

🐇

In the world of code, where changes are key,

A rabbit hops, as happy as can be.

A URL shift, a simple tweak,

Ensures the info is there to seek.

So celebrate this change, though small,

For it contributes to the benefit of all. 🎉


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.json

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 331e106 and 0ac3fd5.
Files selected for processing (1)
  • docs/architecture/adr-034-account-rekeying.md (1} hunks)
Files skipped from review due to trivial changes (1)
  • docs/architecture/adr-034-account-rekeying.md

@MartinKong1990 MartinKong1990 changed the title Update adr-034-account-rekeying.md - fix broken link for Algorand announcing rekeying Bug fix: broken link for Algorand announcing rekeying Oct 26, 2023
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

thanks for the pr

@tac0turtle tac0turtle enabled auto-merge October 26, 2023 08:31
@github-prbot github-prbot requested review from a team, julienrbrt and samricotta and removed request for a team October 26, 2023 08:32
@tac0turtle tac0turtle added this pull request to the merge queue Oct 26, 2023
@julienrbrt julienrbrt changed the title Bug fix: broken link for Algorand announcing rekeying docs: broken link for Algorand announcing rekeying Oct 26, 2023
@julienrbrt julienrbrt disabled auto-merge October 26, 2023 08:46
@julienrbrt julienrbrt removed this pull request from the merge queue due to a manual request Oct 26, 2023
@julienrbrt julienrbrt added this pull request to the merge queue Oct 26, 2023
Merged via the queue into cosmos:main with commit e0d84b7 Oct 26, 2023
50 of 60 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants