chore: mintlify fix broken links#1237
Conversation
|
|
Warning Rate limit exceeded@Crunchyman-ralph has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 58 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (6)
WalkthroughDocumentation-only updates adjusting internal link paths from /docs/... to new root-relative paths within Getting Started and Quick Start pages. No code, logic, or control-flow changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (5)
apps/docs/getting-started/quick-start/configuration-quick.mdx(1 hunks)apps/docs/getting-started/quick-start/execute-quick.mdx(1 hunks)apps/docs/getting-started/quick-start/quick-start.mdx(1 hunks)apps/docs/getting-started/quick-start/tasks-quick.mdx(1 hunks)apps/docs/introduction.mdx(1 hunks)
🧰 Additional context used
🧠 Learnings (8)
📓 Common learnings
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/self_improve.mdc:0-0
Timestamp: 2025-07-18T17:13:11.229Z
Learning: Update references to external docs
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/self_improve.mdc:0-0
Timestamp: 2025-07-18T17:13:11.229Z
Learning: Document breaking changes
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: public/assets/.windsurfrules:0-0
Timestamp: 2025-09-22T16:42:10.070Z
Learning: Keep documentation updated: sync examples with code, refresh external doc links, maintain related-rule links, and document breaking changes
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1178
File: packages/tm-core/src/auth/config.ts:5-7
Timestamp: 2025-09-02T21:51:27.921Z
Learning: The user Crunchyman-ralph prefers not to use node: scheme imports (e.g., 'node:os', 'node:path') for Node.js core modules and considers suggestions to change bare imports to node: scheme as too nitpicky.
📚 Learning: 2025-09-22T16:42:10.070Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: public/assets/.windsurfrules:0-0
Timestamp: 2025-09-22T16:42:10.070Z
Learning: Use complexity-report to view formatted analysis and suggested actions; generate one if missing
Applied to files:
apps/docs/getting-started/quick-start/tasks-quick.mdx
📚 Learning: 2025-09-22T16:42:10.070Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: public/assets/.windsurfrules:0-0
Timestamp: 2025-09-22T16:42:10.070Z
Learning: Run analyze-complexity and review scripts/task-complexity-report.json (or use complexity-report) to prioritize and inform subtask generation
Applied to files:
apps/docs/getting-started/quick-start/tasks-quick.mdx
📚 Learning: 2025-09-22T16:42:10.070Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: public/assets/.windsurfrules:0-0
Timestamp: 2025-09-22T16:42:10.070Z
Learning: Use task-master analyze-complexity with appropriate options (output, model, threshold, file, research) to produce actionable reports
Applied to files:
apps/docs/getting-started/quick-start/tasks-quick.mdx
📚 Learning: 2025-07-18T17:13:11.229Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/self_improve.mdc:0-0
Timestamp: 2025-07-18T17:13:11.229Z
Learning: Document breaking changes
Applied to files:
apps/docs/getting-started/quick-start/quick-start.mdx
📚 Learning: 2025-07-18T17:10:53.657Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.657Z
Learning: Guide for using Task Master to manage task-driven development workflows with tagged task lists support (dev_workflow.mdc).
Applied to files:
apps/docs/getting-started/quick-start/quick-start.mdxapps/docs/getting-started/quick-start/execute-quick.mdx
📚 Learning: 2025-07-18T17:10:53.657Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.657Z
Learning: Comprehensive reference for Taskmaster MCP tools and CLI commands with tagged task lists information (taskmaster.mdc).
Applied to files:
apps/docs/getting-started/quick-start/quick-start.mdxapps/docs/getting-started/quick-start/execute-quick.mdx
📚 Learning: 2025-07-18T17:10:12.881Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/dev_workflow.mdc:0-0
Timestamp: 2025-07-18T17:10:12.881Z
Learning: For CLI usage, install Taskmaster globally with `npm install -g task-master-ai` or use locally via `npx task-master-ai ...`.
Applied to files:
apps/docs/getting-started/quick-start/quick-start.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Test
🔇 Additional comments (4)
apps/docs/getting-started/quick-start/configuration-quick.mdx (1)
111-111: LGTM on link normalization; please verify target exists.Root-relative path looks correct. Confirm that
/best-practices/configuration-advancedresolves (and/or a redirect exists).apps/docs/getting-started/quick-start/tasks-quick.mdx (1)
69-69: LGTM; confirm destination page is present.
/getting-started/quick-start/execute-quickshould map toapps/docs/getting-started/quick-start/execute-quick.mdx(or have a redirect).apps/docs/introduction.mdx (1)
7-7: LGTM; confirm the quick-start index route.Ensure
/getting-started/quick-startresolves to the correct page (typicallyquick-start.mdxin this folder).apps/docs/getting-started/quick-start/quick-start.mdx (1)
9-15: Approve — path normalization verified; links valid.
Script confirms each target file exists and no stale '/docs/' links were found under apps/docs.
| By now you have all you need to get started executing code faster and smarter with Task Master. | ||
|
|
||
| If you have any questions please check out [Frequently Asked Questions](/docs/getting-started/faq) | ||
| If you have any questions please check out [Frequently Asked Questions](/getting-started/faq) |
There was a problem hiding this comment.
🧹 Nitpick
Minor punctuation nit.
Consider ending the sentence with a period.
-If you have any questions please check out [Frequently Asked Questions](/getting-started/faq)
+If you have any questions please check out [Frequently Asked Questions](/getting-started/faq).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| If you have any questions please check out [Frequently Asked Questions](/getting-started/faq) | |
| If you have any questions please check out [Frequently Asked Questions](/getting-started/faq). |
🤖 Prompt for AI Agents
In apps/docs/getting-started/quick-start/execute-quick.mdx around line 59, the
sentence "If you have any questions please check out [Frequently Asked
Questions](/getting-started/faq)" is missing terminal punctuation; add a period
at the end of the sentence so it reads ".../faq)." followed by a period (or
place the period inside the parentheses if you prefer sentence punctuation
rules) to complete the sentence.
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
apps/docs/README.md (1)
22-24: Fix broken relative link in apps/docs/README.mdReplace "../README.md" with "../../README.md" — "../README.md" resolves to apps/README.md (missing); the repo root README.md exists.
Location: apps/docs/README.md (lines 22-24)
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
apps/docs/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (9)
📓 Common learnings
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/self_improve.mdc:0-0
Timestamp: 2025-07-18T17:13:11.229Z
Learning: Update references to external docs
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/self_improve.mdc:0-0
Timestamp: 2025-07-18T17:13:11.229Z
Learning: Document breaking changes
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: public/assets/.windsurfrules:0-0
Timestamp: 2025-09-22T16:42:10.070Z
Learning: Keep documentation updated: sync examples with code, refresh external doc links, maintain related-rule links, and document breaking changes
Learnt from: Crunchyman-ralph
PR: eyaltoledano/claude-task-master#1178
File: packages/tm-core/src/auth/config.ts:5-7
Timestamp: 2025-09-02T21:51:27.921Z
Learning: The user Crunchyman-ralph prefers not to use node: scheme imports (e.g., 'node:os', 'node:path') for Node.js core modules and considers suggestions to change bare imports to node: scheme as too nitpicky.
📚 Learning: 2025-07-18T17:13:11.229Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/self_improve.mdc:0-0
Timestamp: 2025-07-18T17:13:11.229Z
Learning: Document breaking changes
Applied to files:
apps/docs/README.md
📚 Learning: 2025-07-18T17:10:53.657Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.657Z
Learning: Comprehensive reference for Taskmaster MCP tools and CLI commands with tagged task lists information (taskmaster.mdc).
Applied to files:
apps/docs/README.md
📚 Learning: 2025-07-18T17:10:53.657Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.657Z
Learning: Guide for using Task Master to manage task-driven development workflows with tagged task lists support (dev_workflow.mdc).
Applied to files:
apps/docs/README.md
📚 Learning: 2025-07-18T17:10:53.657Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.657Z
Learning: Describes the high-level architecture of the Task Master CLI application, including the new tagged task lists system (architecture.mdc).
Applied to files:
apps/docs/README.md
📚 Learning: 2025-07-18T17:10:12.881Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/dev_workflow.mdc:0-0
Timestamp: 2025-07-18T17:10:12.881Z
Learning: Use the Taskmaster command set (`task-master` CLI or MCP tools) for all task management operations: listing, expanding, updating, tagging, and status changes.
Applied to files:
apps/docs/README.md
📚 Learning: 2025-07-18T17:10:53.657Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.657Z
Learning: Guidelines for implementing and interacting with the Task Master MCP Server (mcp.mdc).
Applied to files:
apps/docs/README.md
📚 Learning: 2025-07-18T17:10:53.657Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: .cursor/rules/glossary.mdc:0-0
Timestamp: 2025-07-18T17:10:53.657Z
Learning: Guidelines for implementing and maintaining tests for Task Master CLI (tests.mdc).
Applied to files:
apps/docs/README.md
📚 Learning: 2025-08-11T12:30:23.843Z
Learnt from: CR
PR: eyaltoledano/claude-task-master#0
File: CLAUDE.md:0-0
Timestamp: 2025-08-11T12:30:23.843Z
Learning: Import Task Master's development workflow commands and guidelines; treat the contents of ./.taskmaster/CLAUDE.md as if included in the main CLAUDE.md
Applied to files:
apps/docs/README.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Test
🔇 Additional comments (6)
apps/docs/README.md (6)
3-3: LGTM on intro copy refresh.
Concise and clear.
11-11: Header rename to Core Capabilities looks good.
Matches the reorg intent.
17-17: Header rename to Best Practices is fine.
7-9: Verify new root-relative Getting Started paths resolve under current Mintlify basePath.apps/docs/README.md (lines 7–9) uses root-relative links (/getting-started/...). I couldn't find a Mintlify config (mint.json / mint.config.*) and searches didn't locate quick-start, requirements, or installation pages — these links will 404 if the site is served under a subpath. Confirm basePath is '/' in Mintlify config or update links to be basePath-aware (relative paths or framework/link helper).
13-15: Confirm capability route slugs exist: mcp, cli-root-commands, task-structureapps/docs/README.md (lines 13–15) — ensure pages for those slugs (.md/.mdx) exist; local search returned errors and found no matches, so verify the target files/routes or update the links to avoid broken sidebar/navigation.
19-20: Validate Best Practices targets (configuration-advanced, advanced-tasks) — OK
Files exist at apps/docs/best-practices/configuration-advanced.mdx and apps/docs/best-practices/advanced-tasks.mdx.
| - [Quick Start Guide](/getting-started/quick-start) - Complete setup and first-time usage guide | ||
| - [Requirements](/getting-started/quick-start/requirements) - What you need to get started | ||
| - [Installation](/getting-started/quick-start/installation) - How to install Task Master | ||
|
|
||
| ## Reference | ||
| ## Core Capabilities | ||
|
|
||
| - [Command Reference](archive/ccommand-reference.md) - Complete list of all available commands | ||
| - [Task Structure](archive/ctask-structure.md) - Understanding the task format and features | ||
| - [MCP Tools](/capabilities/mcp) - Model Control Protocol integration | ||
| - [CLI Commands](/capabilities/cli-root-commands) - Command line interface reference | ||
| - [Task Structure](/capabilities/task-structure) - Understanding tasks and subtasks | ||
|
|
||
| ## Examples & Licensing | ||
| ## Best Practices | ||
|
|
||
| - [Example Interactions](archive/cexamples.md) - Common Cursor AI interaction examples | ||
| - [Licensing Information](archive/clicensing.md) - Detailed information about the license | ||
| - [Advanced Configuration](/best-practices/configuration-advanced) - Detailed configuration options | ||
| - [Advanced Tasks](/best-practices/advanced-tasks) - Working with complex task structures |
There was a problem hiding this comment.
🧹 Nitpick
Add automated link checking to prevent future Mintlify link regressions.
Integrate a link checker in CI (e.g., lychee) scoped to apps/docs to catch 404s proactively.
#!/bin/bash
# Example local check (requires lychee installed): https://github.com/lycheeverse/lychee
# Install: cargo install lychee
lychee --no-progress --base "http://localhost:3000" --accept 200,206 'apps/docs/**/*.md*'🤖 Prompt for AI Agents
In apps/docs/README.md around lines 7-20: add an automated link-check step to CI
scoped to apps/docs to catch 404s; create a GitHub Actions job (or expand
existing CI) that installs or caches lychee (or uses a prebuilt binary), starts
the docs app or uses a base URL, and runs lychee against apps/docs/**/*.md*
(with --base pointing to the deployed or local preview URL and --accept 200,206)
failing the job on broken links; ensure the job runs on PRs and optionally on a
schedule, and document the new CI job in the repo README so future contributors
know how link checks are executed.
3b53c49 to
51694b6
Compare
What type of PR is this?
Description
Related Issues
How to Test This
# Example commands or stepsExpected result:
Contributor Checklist
npm run changesetnpm testnpm run format-check(ornpm run formatto fix)Changelog Entry
For Maintainers
Summary by CodeRabbit