Skip to content

docs: fix broken links, redundant onboarding content, and release URL - #3581

Open
Rohinthan wants to merge 1 commit into
AutoMQ:mainfrom
Rohinthan:rohinthan/fix-docs-and-links
Open

docs: fix broken links, redundant onboarding content, and release URL#3581
Rohinthan wants to merge 1 commit into
AutoMQ:mainfrom
Rohinthan:rohinthan/fix-docs-and-links

Conversation

@Rohinthan

@Rohinthan Rohinthan commented Sep 6, 2026

Copy link
Copy Markdown

Why

  • Malformed WeChat group link and outdated repository links in CONTRIBUTING_GUIDE.md and automq_release.py.
  • Duplicated introductory paragraphs in CONTRIBUTING_GUIDE.md.
  • Outdated docker-compose tag URL in README.md.

What

  • Fixed WeChat image path to docs/images/automq-wechat.png.
  • Updated repository URLs from automq-for-kafka to automq.
  • Cleaned up duplicated onboarding text and headings.
  • Updated docker-compose quickstart link to main branch.

More detailed description of your change,
if necessary. The PR title and PR message become
the squashed commit message, so use a separate
comment to ping reviewers.

Summary of testing strategy (including rationale)
for the feature or bug fix. Unit and/or integration
tests are expected for any behaviour change and
system tests should be considered for larger changes.

Checklist

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

## Why
- Malformed WeChat group link and outdated repository links in CONTRIBUTING_GUIDE.md and automq_release.py.
- Duplicated introductory paragraphs in CONTRIBUTING_GUIDE.md.
- Outdated docker-compose tag URL in README.md.

## What
- Fixed WeChat image path to docs/images/automq-wechat.png.
- Updated repository URLs from automq-for-kafka to automq.
- Cleaned up duplicated onboarding text and headings.
- Updated docker-compose quickstart link to main branch.
@CLAassistant

CLAassistant commented Sep 6, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants