Skip to content

chore: fix broken docs links#1633

Merged
Wirasm merged 1 commit into
coleam00:devfrom
shiv19:chore/docs-broken-links-fix
May 12, 2026
Merged

chore: fix broken docs links#1633
Wirasm merged 1 commit into
coleam00:devfrom
shiv19:chore/docs-broken-links-fix

Conversation

@shiv19

@shiv19 shiv19 commented May 11, 2026 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

I noticed that the links to the getting started page was broken from the Slack adapters page.
Some other pages were affected too. This PR fixes the broken links.

Before:

[Getting Started](/getting-started/)

After:

[Getting Started](/getting-started/overview/)

Summary by CodeRabbit

  • Documentation
    • Updated Getting Started links across adapter documentation (Discord, Gitea, GitHub, Slack, and Telegram) to reference the dedicated overview page for improved user onboarding.
    • Updated developer guide documentation to point to the revised Getting Started overview page.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 11, 2026 •
edited
Loading

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c9483702-7465-46d3-a384-0093e319b2d3

📥 Commits

Reviewing files that changed from the base of the PR and between 78d32cf and 6635003.

📒 Files selected for processing (6)
  • packages/docs-web/src/content/docs/adapters/community/discord.md
  • packages/docs-web/src/content/docs/adapters/community/gitea.md
  • packages/docs-web/src/content/docs/adapters/github.md
  • packages/docs-web/src/content/docs/adapters/slack.md
  • packages/docs-web/src/content/docs/adapters/telegram.md
  • packages/docs-web/src/content/docs/contributing/new-developer-guide.md
📝 Walkthrough

Walkthrough

This PR updates internal documentation links across six markdown files—Discord, Gitea, GitHub, Slack, and Telegram adapter guides, plus the developer onboarding guide—to redirect "Getting Started" references from the generic /getting-started/ path to a more specific /getting-started/overview/ endpoint.

Changes

Documentation Link Consolidation

Layer / File(s) Summary
Prerequisites and Getting Started Links
packages/docs-web/src/content/docs/adapters/community/discord.md, packages/docs-web/src/content/docs/adapters/community/gitea.md, packages/docs-web/src/content/docs/adapters/github.md, packages/docs-web/src/content/docs/adapters/slack.md, packages/docs-web/src/content/docs/adapters/telegram.md, packages/docs-web/src/content/docs/contributing/new-developer-guide.md		 Updated all prerequisite section links and Getting Started navigation references across adapter documentation to point to /getting-started/overview/ instead of /getting-started/.

🎯 1 (Trivial) | ⏱️ ~2 minutes

🐰 Links now align with care,
All adapters point with grace,
To overview's welcoming space,
No more generic, just right there,
Getting started feels so rare! 🚀

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete; it lacks most required sections from the template including UX Journey, Architecture Diagram, Labels, Validation Evidence, Security Impact, Compatibility, Human Verification, Side Effects, and Rollback Plan. Complete the PR description using the repository template, including at minimum: Validation Evidence, Security Impact, Compatibility, Human Verification, Side Effects, and Rollback Plan sections.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarizes the main change: fixing broken documentation links across multiple adapter and guide pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@Wirasm

Wirasm commented May 11, 2026

Copy link
Copy Markdown
Collaborator

Review Summary

Verdict: ready-to-merge

This PR is a clean, well-scoped documentation maintenance fix — it corrects six internal links from /getting-started/ to /getting-started/overview/. No user-facing behavior, API, or CLI surface is affected. All links are in-sync once the PR lands.

Blocking issues

None.

Suggested fixes

None.

Minor / nice-to-have

None — though for future PRs of larger scope, consider filling in more of the PR template sections (Validation Evidence, Security Impact, Compatibility, Human Verification, Side Effects, and Rollback Plan) to help reviewers assess the change more thoroughly.

Compliments

Good job keeping the scope tight — one link type fixed consistently across six files. The before/after example in the PR body makes the change easy to understand at a glance.

Reviewed via maintainer-review-pr workflow (Pi/Minimax). Aspects run: docs-impact.

@Wirasm Wirasm merged commit dffefd6 into coleam00:dev May 12, 2026
1 check passed
@github-actions github-actions Bot mentioned this pull request May 13, 2026
Open
cropse pushed a commit to cropse/Archon that referenced this pull request May 19, 2026
@shiv19 @cropse0219
chore: fix broken docs links (coleam00#1633)
6648424
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@shiv19 @Wirasm