docs icon indicating copy to clipboard operation
docs copied to clipboard

feat: add errors page

Open jainpawan21 opened this issue 7 months ago β€’ 2 comments

jainpawan21 avatar Apr 15 '25 11:04 jainpawan21

Deploy Preview for docs-novu ready!

Name Link
Latest commit 04a3714613757f30161b13c33f4ed881394b3c61
Latest deploy log https://app.netlify.com/projects/docs-novu/deploys/6839fa063f814a0008afb94d
Deploy Preview https://deploy-preview-820--docs-novu.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

netlify[bot] avatar Apr 15 '25 11:04 netlify[bot]

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

A new documentation page detailing common notification workflow errors and their solutions was added. The navigation structure was updated to include this new page and to rename the legacy documentation entry. Minor frontmatter and heading adjustments were made to the legacy documentation file.

Changes

File(s) Change Summary
content/docs/platform/additional-resources/errors.mdx Added a new documentation page explaining common notification workflow errors and solutions.
content/docs/platform/additional-resources/legacy-documentation.mdx Updated frontmatter with pageTitle, changed main heading casing, and added a trailing newline.
content/docs/platform/meta.json Updated navigation: added "errors" page and renamed legacy documentation entry.

Poem

In the warren of docs, a new path appears,
Guiding lost bunnies through errors and fears.
With fixes and tips, solutions in tow,
The legacy’s renamed, so onward we go!
πŸ‡βœ¨
Now hoppers and coders, your troubles are fewβ€”
For answers are waiting, just hop on through!


πŸ“œ Recent review details

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

πŸ“₯ Commits

Reviewing files that changed from the base of the PR and between fdb419dc77b24475ada39e52995c5a332bd898ea and 04a3714613757f30161b13c33f4ed881394b3c61.

πŸ“’ Files selected for processing (3)
  • content/docs/platform/additional-resources/errors.mdx (1 hunks)
  • content/docs/platform/additional-resources/legacy-documentation.mdx (1 hunks)
  • content/docs/platform/meta.json (1 hunks)

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
πŸͺ§ 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 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.

coderabbitai[bot] avatar May 30 '25 18:05 coderabbitai[bot]