Skip to content

fix: docs links#97

Merged
waltergalvao merged 6 commits intomainfrom
fix/docs-links
Mar 21, 2026
Merged

fix: docs links#97
waltergalvao merged 6 commits intomainfrom
fix/docs-links

Conversation

@waltergalvao
Copy link
Copy Markdown
Contributor

@waltergalvao waltergalvao commented Mar 21, 2026

Greptile Summary

This PR fixes a broad set of broken documentation links across the web app, API service, and README — updating stale features/ URL paths to their correct locations under metrics-and-insights/, automations/, and platform/. It also adds a new step-by-step "Setting up deployments for DORA Metrics" guide section to deployments.mdx and deep-links to it from relevant UI components.

  • Updated 10+ docs.sweetr.dev URLs from deprecated features/ paths to their restructured destinations (metrics-and-insights/, automations/, platform/)
  • Fixed two http://docs.sweetr.dev links to use https:// in health-metrics pages
  • Fixed two hardcoded http://localhost:3000 links in README.md that pointed at a local dev server instead of production docs
  • Added anchor #setting-up-deployments-for-dora-metrics to deployment-related links in alert-enable-feature.tsx and timeline-pull-request.tsx so users land directly on the setup guide
  • Added a comprehensive step-by-step DORA metrics deployment setup guide to apps/docs/platform/deployments.mdx, replacing the previous minimal "Deployment triggers" section

Confidence Score: 5/5

  • This PR is safe to merge — all changes are URL string updates and a docs content addition with no logic impact.
  • Every change is a straightforward URL correction (path restructure, http→https, localhost→production). The only non-trivial change is the new content block in deployments.mdx, which is purely additive documentation. No application logic, data models, or API contracts are touched.
  • No files require special attention.

Important Files Changed

Filename Overview
README.md Updated all docs links from deprecated features/ paths to correct metrics-and-insights/ and automations/ paths; fixed two localhost links to production URLs; reorganized the analytics screenshot table to highlight DORA metrics.
apps/api/src/app/digests/services/digest-team-metrics.service.ts Single URL fix: features/deploymentsplatform/deployments in the Slack digest button link.
apps/docs/platform/deployments.mdx Added a new "Setting up deployments for DORA Metrics" step-by-step guide section and relocated the deployment trigger content into it; also removed the redundant standalone "Deployment triggers" section.
apps/web/src/app/automations/use-automation-cards.tsx Updated docsUrl for three automation cards (incident-detection, pr-size-labeler, pr-title-check) from features/automations/ to automations/ path.
apps/web/src/components/alert-enable-feature/alert-enable-feature.tsx Updated deployments docs URL and added anchor #setting-up-deployments-for-dora-metrics to deep-link into the newly added guide section.
apps/web/src/components/card-pull-request/timeline-pull-request.tsx Same URL fix as alert-enable-feature.tsx — updated deployments path and added DORA metrics anchor.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User clicks docs link in UI / README] --> B{Old path?}
    B -- "features/deployments" --> C["platform/deployments\n(+ #setting-up-deployments-for-dora-metrics anchor)"]
    B -- "features/environments" --> D["platform/environments"]
    B -- "features/automations/*" --> E["automations/*"]
    B -- "features/team/*\n(http://)" --> F["metrics-and-insights/team/*\n(https://)"]
    B -- "features/pull-requests\nfeatures/code-reviews" --> G["metrics-and-insights/work-log\nmetrics-and-insights/wip\nmetrics-and-insights/pull-requests\nmetrics-and-insights/code-reviews"]
    B -- "localhost:3000/features/automations/*" --> H["docs.sweetr.dev/automations/*"]
Loading

Last reviewed commit: "chore: update README"

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 21, 2026

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

This PR updates documentation links across the codebase to align with a URL structure reorganization, redirecting feature links from /features/... paths to /metrics-and-insights/..., /automations/..., and /platform/... paths. It also updates README.md marketing copy with new feature links and adds a "Setting up deployments for DORA Metrics" guide to the platform deployments documentation.

Changes

Cohort / File(s) Summary
Team Metrics Health & Performance Pages
apps/web/src/app/humans/teams/[id]/health-and-performance/.../code-review-distribution/page.tsx, apps/web/src/app/humans/teams/[id]/health-and-performance/.../time-to-approve/page.tsx, apps/web/src/app/humans/teams/[id]/health-and-performance/.../time-to-first-review/page.tsx, apps/web/src/app/humans/teams/[id]/health-and-performance/.../cycle-time/page.tsx, apps/web/src/app/humans/teams/[id]/health-and-performance/.../size-distribution/page.tsx, apps/web/src/app/humans/teams/[id]/health-and-performance/.../time-to-merge/page.tsx
Updated ButtonDocs href attributes from http://docs.sweetr.dev/features/team/... to https://docs.sweetr.dev/metrics-and-insights/team/... across six team performance pages.
Automation Settings & Configuration
apps/web/src/app/automations/settings/pr-title-check/components/form-pr-title-check-settings/form-pr-title-check-settings.tsx, apps/web/src/app/automations/use-automation-cards.tsx
Updated documentation URLs from https://docs.sweetr.dev/features/automations/... to https://docs.sweetr.dev/automations/... in PR title check form and automation cards configuration.
Platform & Deployments Links
apps/api/src/app/digests/services/digest-team-metrics.service.ts, apps/web/src/app/systems/applications/upsert/components/form-upsert-application/input-deployment-trigger.tsx, apps/web/src/components/alert-enable-feature/alert-enable-feature.tsx, apps/web/src/components/card-pull-request/timeline-pull-request.tsx
Updated deployment-related documentation links from https://docs.sweetr.dev/features/deployments to https://docs.sweetr.dev/platform/deployments (some with fragment identifier #setting-up-deployments-for-dora-metrics).
Environment Configuration
apps/web/src/app/systems/environments/page.tsx
Updated environment documentation link from https://docs.sweetr.dev/features/environments to https://docs.sweetr.dev/platform/environments.
README Marketing Updates
README.md
Reorganized "Metrics" table structure with new "DORA Metrics" section, updated feature links to /metrics-and-insights/... and /automations/... paths, changed DX automation examples from localhost to https://docs.sweetr.dev/automations/..., and updated hero tagline with "Free to self-host" link.
Deployments Documentation
apps/docs/platform/deployments.mdx
Added comprehensive "Setting up deployments for DORA Metrics" section with step-by-step guidance (creating applications, selecting deployment triggers, sending first deployment, backfilling historical data) and removed standalone "Deployment triggers" section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • chore: update docs #93 — Documentation URL reorganization and new platform deployments page structure that aligns with the redirected links in this PR.
  • feat: add dora to metrics digest #81 — Modifies digest-team-metrics service logic related to Slack digest buttons and the same deployment link updated here.
  • feat: setup deployments alerts #80 — Updates TimelinePullRequest component for feature-adoption gating in the same component where this PR updates the deployment docs link.

Suggested labels

small

Suggested reviewers

  • sweetrdev
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix: docs links' is directly related to the main objective of the PR, which is updating and fixing broken documentation links across the codebase.
Description check ✅ Passed The description comprehensively explains the PR's scope, listing specific URL updates, file changes, and the rationale for documentation restructuring.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-links

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.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

1 issue found across 15 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="README.md">

<violation number="1" location="README.md:7">
P3: Use `target="_blank"` for the self-host link; `target="blank"` is a named browsing context, not the standard new-tab target.</violation>
</file>

Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.

Comment thread README.md
<h3 align="center">sweetr.dev</h3>
<p align="center">
<i>Optimize delivery, enhance developer experience, and foster team growth with the sweetest Developer Intelligence Platform.</i>
<i>Insights and automations your dev team will actually trust. Free to <a href="https://docs.sweetr.dev/get-started/self-host" target="blank">self-host</a>.</i>
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot Mar 21, 2026

Choose a reason for hiding this comment

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

P3: Use target="_blank" for the self-host link; target="blank" is a named browsing context, not the standard new-tab target.

Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At README.md, line 7:

<comment>Use `target="_blank"` for the self-host link; `target="blank"` is a named browsing context, not the standard new-tab target.</comment>

<file context>
@@ -4,7 +4,7 @@
 <h3 align="center">sweetr.dev</h3>
 <p align="center">
-  <i>Optimize delivery, enhance developer experience, and foster team growth with the sweetest Developer Intelligence Platform.</i>
+  <i>Insights and automations your dev team will actually trust. Free to <a href="https://docs.sweetr.dev/get-started/self-host" target="blank">self-host</a>.</i>
 </p>
 
</file context>
Suggested change
<i>Insights and automations your dev team will actually trust. Free to <a href="https://docs.sweetr.dev/get-started/self-host" target="blank">self-host</a>.</i>
<i>Insights and automations your dev team will actually trust. Free to <a href="https://docs.sweetr.dev/get-started/self-host" target="_blank">self-host</a>.</i>
Fix with Cubic

@waltergalvao waltergalvao merged commit 005796b into main Mar 21, 2026
9 of 11 checks passed
@waltergalvao waltergalvao deleted the fix/docs-links branch March 21, 2026 06:55
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