Update documentation to use consistent "path instructions" terminology #472
Conversation
WalkthroughThe documentation was updated to consistently replace the term "path-based instructions" with "path instructions" or "file path instructions" across several files. These changes affect headings, descriptive text, and hyperlink labels, ensuring uniform terminology throughout the documentation. No code, logic, or public interfaces were modified. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-Merge Checks (2 passed, 1 warning)❌ Failed Checks (1 warning)
✅ Passed Checks (2 passed)
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
🧰 Additional context used🔍 MCP Research (1 server)Linear: The PR standardizes the term "path instructions" to describe per-file review directives in ⏰ 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). (2)
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
coderabbitai
bot
changed the title
Deploying coderabbit-docs with
|
| Latest commit: |
3aae6b7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://20e07dbb.coderabbit-docs.pages.dev |
| Branch Preview URL: | https://path-based-to-path-fix.coderabbit-docs.pages.dev |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/overview/introduction.md (1)
53-53: Optional: add hash fragment for direct jumpThe new link omits a fragment, so readers land on the top of a very long page.
If you add the#path-instructionsalias (or keep#path-based) you can deep-link:-/guides/review-instructions +/guides/review-instructions#path-instructionsdocs/changelog.md (1)
154-155: Terminology drift: “file path instructions” vs. “Path instructions”Everywhere else the docs now use “Path instructions”. The adjective “file” here is new and could re-introduce inconsistency.
Consider:
-You can now provide file path instructions +You can now provide Path instructions
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/changelog.md(1 hunks)docs/guides/initial-configuration.md(2 hunks)docs/guides/review-instructions.md(1 hunks)docs/overview/introduction.md(1 hunks)
🧠 Learnings (4)
docs/changelog.md (2)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: aravindputrevu
PR: #121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the /img/ directory, not /static/img/.
docs/overview/introduction.md (3)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
Learnt from: aravindputrevu
PR: #121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the /img/ directory, not /static/img/.
docs/guides/review-instructions.md (3)
Learnt from: NatoBoram
PR: #165
File: docs/finishing-touches/docstrings.md:9-9
Timestamp: 2024-12-05T21:29:59.510Z
Learning: The link /future-developments#finishing-touches in docs/finishing-touches/docstrings.md is correct and should not be flagged as incorrect in future reviews.
Learnt from: tyaga001
PR: #155
File: docs/getting-started/quickstart.md:22-22
Timestamp: 2024-11-28T16:45:08.224Z
Learning: In the coderabbitai/coderabbit-docs repository, when reviewing markdown files, image paths that start with /img/ are correct and should not include the static prefix, even though the images are located in the static/ directory.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
docs/guides/initial-configuration.md (4)
Learnt from: NatoBoram
PR: #165
File: docs/finishing-touches/docstrings.md:9-9
Timestamp: 2024-12-05T21:29:59.510Z
Learning: The link /future-developments#finishing-touches in docs/finishing-touches/docstrings.md is correct and should not be flagged as incorrect in future reviews.
Learnt from: aravindputrevu
PR: #121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the /img/ directory, not /static/img/.
Learnt from: tyaga001
PR: #155
File: docs/getting-started/quickstart.md:22-22
Timestamp: 2024-11-28T16:45:08.224Z
Learning: In the coderabbitai/coderabbit-docs repository, when reviewing markdown files, image paths that start with /img/ are correct and should not include the static prefix, even though the images are located in the static/ directory.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
🧰 Additional context used
🧠 Learnings (4)
docs/changelog.md (2)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: aravindputrevu
PR: #121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the /img/ directory, not /static/img/.
docs/overview/introduction.md (3)
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
Learnt from: aravindputrevu
PR: #402
File: docs/guides/setup-best-practices.md:21-21
Timestamp: 2025-06-18T09:22:07.198Z
Learning: The word "CodeRabbit" should always have both C and R capitalized (not "coderabbit", "Coderabbit", or "CoderabbitAI"). The correct format is "CodeRabbit" and "CodeRabbitAI" for the service account. Proactively correct this capitalization in review comments when contributors mistype it.
Learnt from: aravindputrevu
PR: #121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the /img/ directory, not /static/img/.
docs/guides/review-instructions.md (3)
Learnt from: NatoBoram
PR: #165
File: docs/finishing-touches/docstrings.md:9-9
Timestamp: 2024-12-05T21:29:59.510Z
Learning: The link /future-developments#finishing-touches in docs/finishing-touches/docstrings.md is correct and should not be flagged as incorrect in future reviews.
Learnt from: tyaga001
PR: #155
File: docs/getting-started/quickstart.md:22-22
Timestamp: 2024-11-28T16:45:08.224Z
Learning: In the coderabbitai/coderabbit-docs repository, when reviewing markdown files, image paths that start with /img/ are correct and should not include the static prefix, even though the images are located in the static/ directory.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
docs/guides/initial-configuration.md (4)
Learnt from: NatoBoram
PR: #165
File: docs/finishing-touches/docstrings.md:9-9
Timestamp: 2024-12-05T21:29:59.510Z
Learning: The link /future-developments#finishing-touches in docs/finishing-touches/docstrings.md is correct and should not be flagged as incorrect in future reviews.
Learnt from: aravindputrevu
PR: #121
File: docs/guides/delete-account.md:46-47
Timestamp: 2024-10-31T16:33:25.070Z
Learning: In the CodeRabbit documentation, image paths in markdown files should reference the /img/ directory, not /static/img/.
Learnt from: tyaga001
PR: #155
File: docs/getting-started/quickstart.md:22-22
Timestamp: 2024-11-28T16:45:08.224Z
Learning: In the coderabbitai/coderabbit-docs repository, when reviewing markdown files, image paths that start with /img/ are correct and should not include the static prefix, even though the images are located in the static/ directory.
Learnt from: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#0
File: :0-0
Timestamp: 2025-06-02T14:07:49.512Z
Learning: For files in docs/tools/*.md directory: Do not recommend installation instructions or usage setup steps. All tools documented in this directory are pre-installed in CodeRabbit's default environment and require no installation steps from users. Documentation should focus on tool capabilities and features only.
⏰ 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 (3)
docs/guides/review-instructions.md (1)
12-12: Anchor alias would avoid hard-coupling the new wording to the legacy slugYou changed the visible heading to “Path instructions” but kept the explicit slug
{#path-based}.
That preserves all existing inbound links, but any future author is likely to assume the natural slug#path-instructions, create that link, and hit a 404.Add a second, silent anchor so both IDs resolve:
-## Path instructions {#path-based} +<a id="path-instructions"></a> +## Path instructions {#path-based}This keeps backward compatibility while preventing new dead links.
[tags: suggest_essential_refactor]docs/guides/initial-configuration.md (2)
84-85: Link now feels out-of-sync with the section’s wordingThe link text reads “Path instructions” but it still points to
#path-based.
If you adopt the dual-anchor approach suggested inreview-instructions.md, nothing breaks.
Otherwise, update the fragment to match whatever canonical slug you settle on.No action required if you add the alias; otherwise change:
-[Path instructions](/guides/review-instructions#path-based) +[Path instructions](/guides/review-instructions#path-instructions)
118-119: Consistency: confirm anchor choice before mergingSame anchor question as above (“Path instructions” text →
#path-basedslug).
Whichever slug you choose, make sure both occurrences in this file are updated together.
[tags: request_verification]
aravindputrevu
assigned
89hardy,
edgarcerecerez,
jmacdotorg and
aravindputrevu and unassigned
jmacdotorg,
89hardy and
edgarcerecerez
No description provided.