Skip to content

Don't require typescript-specific reveiws for ToC changes #452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

jmacdotorg
Copy link
Contributor

No description provided.

Copy link
Contributor

coderabbitai bot commented Jul 15, 2025

Caution

Review failed

Failed to post review comments.

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6667012 and f7e2426.

📒 Files selected for processing (2)
  • .github/CODEOWNERS (1 hunks)
  • docs/guides/learnings.md (1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: NatoBoram
PR: coderabbitai/coderabbit-docs#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: 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: alexcoderabbitai
PR: coderabbitai/coderabbit-docs#176
File: docs/self-hosted/bitbucket.md:37-37
Timestamp: 2024-12-13T15:10:43.483Z
Learning: In the `docs` repository, it's acceptable to use `127.0.0.1` in documentation examples, and CodeRabbit should not flag it as an issue.
Learnt from: NatoBoram
PR: coderabbitai/coderabbit-docs#125
File: .github/CODEOWNERS:1-1
Timestamp: 2024-10-31T19:55:28.342Z
Learning: When suggesting modifications to the CODEOWNERS file, ensure that only existing teams or users are included, and avoid inventing teams that don't exist in the repository.
Learnt from: aravindputrevu
PR: coderabbitai/coderabbit-docs#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/`.
.github/CODEOWNERS (1)
Learnt from: NatoBoram
PR: coderabbitai/coderabbit-docs#125
File: .github/CODEOWNERS:1-1
Timestamp: 2024-10-31T19:55:28.342Z
Learning: When suggesting modifications to the CODEOWNERS file, ensure that only existing teams or users are included, and avoid inventing teams that don't exist in the repository.
docs/guides/learnings.md (1)
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.
🪛 LanguageTool
docs/guides/learnings.md

[style] ~17-~17: Consider removing “of” to be more concise
Context: ...nt to a pull request or issue, it loads all of the learnings that it has collected about y...

(ALL_OF_THE)


[style] ~61-~61: Consider removing “of” to be more concise
Context: ...nings**. This displays a paged list of all of the learnings associated with your organiza...

(ALL_OF_THE)


[style] ~91-~91: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...nings, enable the [Opt out] setting. - To disable all CodeRabbit features that re...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

Walkthrough

A new documentation guide about configuring CodeRabbit using chat was added, detailing how learnings are captured and managed. The .github/CODEOWNERS file was updated to explicitly assign ownership of sidebars.ts alongside existing TypeScript file rules. No changes were made to exported or public code entities.

Changes

File(s) Change Summary
.github/CODEOWNERS Explicitly added sidebars.ts to code owners, in addition to the rule for all .ts files.
docs/guides/learnings.md New documentation guide on configuring CodeRabbit learnings via chat, storage, and configuration options.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CodeRabbit (Service Account)
    participant CodeRabbit Web Interface
    participant Learnings Storage

    User->>CodeRabbit (Service Account): Comments preference on PR/issue
    CodeRabbit (Service Account)->>Learnings Storage: Store learning linked to org/account
    User->>CodeRabbit Web Interface: View/edit/delete learnings
    CodeRabbit Web Interface->>Learnings Storage: Query/update/delete learnings
    CodeRabbit (Service Account)->>User: Applies learnings context in future comments
Loading

Poem

🐰
In docs a new guide hops in with delight,
Teaching chat-learnings by day or by night.
CODEOWNERS now guards a sidebar with care,
While rabbits ensure that your configs are fair.
So chat with your bot, let preferences grow—
The garden of learnings continues to show!
🌱

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch toc-reviews

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

Deploying coderabbit-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: f7e2426
Status:🚫  Build failed.

View logs

@jmacdotorg jmacdotorg closed this Jul 15, 2025
@jmacdotorg jmacdotorg deleted the toc-reviews branch July 15, 2025 18:39
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.

1 participant