fix: docs links#97
Conversation
|
Caution Review failedPull request was closed or merged during review WalkthroughThis PR updates documentation links across the codebase to align with a URL structure reorganization, redirecting feature links from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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.
| <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> |
There was a problem hiding this comment.
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>
| <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> |
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 undermetrics-and-insights/,automations/, andplatform/. It also adds a new step-by-step "Setting up deployments for DORA Metrics" guide section todeployments.mdxand deep-links to it from relevant UI components.docs.sweetr.devURLs from deprecatedfeatures/paths to their restructured destinations (metrics-and-insights/,automations/,platform/)http://docs.sweetr.devlinks to usehttps://in health-metrics pageshttp://localhost:3000links inREADME.mdthat pointed at a local dev server instead of production docs#setting-up-deployments-for-dora-metricsto deployment-related links inalert-enable-feature.tsxandtimeline-pull-request.tsxso users land directly on the setup guideapps/docs/platform/deployments.mdx, replacing the previous minimal "Deployment triggers" sectionConfidence Score: 5/5
deployments.mdx, which is purely additive documentation. No application logic, data models, or API contracts are touched.Important Files Changed
features/paths to correctmetrics-and-insights/andautomations/paths; fixed two localhost links to production URLs; reorganized the analytics screenshot table to highlight DORA metrics.features/deployments→platform/deploymentsin the Slack digest button link.docsUrlfor three automation cards (incident-detection, pr-size-labeler, pr-title-check) fromfeatures/automations/toautomations/path.#setting-up-deployments-for-dora-metricsto deep-link into the newly added guide section.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/*"]Last reviewed commit: "chore: update README"