Skip to content

docs: add ipc api and architecture docs#87

Merged
mind-murtaza merged 1 commit into
devfrom
docs/branding-docs
May 31, 2026
Merged

docs: add ipc api and architecture docs#87
mind-murtaza merged 1 commit into
devfrom
docs/branding-docs

Conversation

@Ashminita28
Copy link
Copy Markdown
Collaborator

Description

This PR add IPC contract docs and architecture docs to documentation website

Type of Change

  • Bug fix
  • New feature
  • Refactor (no functional change)
  • Documentation update
  • Style / UI change
  • Build / CI change

Related Issue

Closes #81

Changes Made

  • Added ipc api docs
  • Added architecture docs

Checklist

  • My code follows the project's coding guidelines
  • I have tested my changes locally
  • I have used conventional commit messages
  • I have updated documentation if needed
  • My changes do not introduce new warnings or errors

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 31, 2026

Warning

Review limit reached

@Ashminita28, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 45 minutes and 24 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: ce322718-7a81-45ca-b168-c37eebfe2c63

📥 Commits

Reviewing files that changed from the base of the PR and between d962082 and ab8e9c3.

📒 Files selected for processing (6)
  • docs/docs/architecture.md
  • docs/docs/ipc-api.md
  • docs/sidebars.ts
  • docs/versioned_docs/version-1.0.0/architecture.md
  • docs/versioned_docs/version-1.0.0/ipc-api.md
  • docs/versioned_sidebars/version-1.0.0-sidebars.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/branding-docs

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@mind-murtaza mind-murtaza merged commit 663e9fc into dev May 31, 2026
2 checks passed
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.

2 participants