📝 Update docs

[rflihxyz]

Summary by CodeRabbit

• New Features

  • Added documentation for creating, retrieving, updating, and listing companies, deals, engagements, notes, tasks, and users in any CRM platform.
  • Introduced OpenAPI specifications for creating, retrieving, updating, and listing accounts, comments, contacts, tags, teams, and tickets in any Ticketing Platform.
  • Updated titles and descriptions to reflect the current functionality of various API endpoints.

• Documentation

  • Provided an overview of CRM companies and deals.
  • Refined API endpoint descriptions for better clarity on functionality.
  • Added steps for Mac users regarding the removal of specific directories affecting the build process.

• Bug Fixes

  • Adjusted API endpoint titles and descriptions to accurately represent the retrieval and listing of resources.

[changeset-bot]

⚠️ No Changeset found

Latest commit: ce40a83

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[render]

Your Render PR Server URL is https://panora-backend-api-pr-241.onrender.com.

Follow its progress at https://dashboard.render.com/web/srv-cmojefuv3ddc73efebkg.

[coderabbitai]

Warning

Rate Limit Exceeded

@rflihxyz has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 59 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, 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 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.

Commits

Files that changed from the base of the PR and between 46166c3 and ce40a83.

Walkthrough

The recent update encompasses a comprehensive enhancement of the CRM and Ticketing documentation, introducing new API endpoints for creating, retrieving, updating, and listing various entities such as companies, deals, engagements, notes, tasks, users, accounts, comments, contacts, tags, teams, and tickets. The improvements refine the API's functionality, ensuring a more robust and user-friendly interface for developers working with CRM and Ticketing platforms.

Changes

File Path	Change Summary
.../api/create.mdx	Introduced documentation for creating entities via POST.
.../api/get.mdx	Introduced OpenAPI specs for retrieving entities by ID.
.../api/list.mdx	Introduced functionality to list entities via GET.
.../api/update.mdx	Introduced functionality to update entities via PATCH.
.../companies/overview.mdx	Provided an overview of CRM companies.
.../contacts/api/list.mdx	Refined API endpoint to focus on retrieving CRM contacts.
.../deals/overview.mdx	Updated the title and overview for CRM deals.
.../open-source/contributors.mdx	Removed specific directories affecting the build process.
.../comments/api/list.mdx	Updated the description for listing Ticketing comments.
.../tickets/api/get.mdx	Changed functionality from listing to retrieving tickets.

🐰✍️
In docs of code, we hop and leap,
Through APIs, a promise we keep.
With PATCH, POST, and GET so bright,
We've updated docs, with pure delight. 🌟

 (\(\ 
 ( -.-)
 o_(")(")

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

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>.
  • Generate unit-tests for this file.
• 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 generate unit tests for this file.
  • @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 generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[ghost]

👇 Click on the image for a new way to code review

Legend

[coderabbitai]

Review Status

Actionable comments generated: 5

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between c13e2dc and 46166c3.

Files ignored due to path filters (1)

• docs/mint.json is excluded by: !**/*.json

Files selected for processing (45)

• docs/crm/companies/api/create.mdx (1 hunks)
• docs/crm/companies/api/get.mdx (1 hunks)
• docs/crm/companies/api/list.mdx (1 hunks)
• docs/crm/companies/api/update.mdx (1 hunks)
• docs/crm/companies/overview.mdx (1 hunks)
• docs/crm/contacts/api/list.mdx (1 hunks)
• docs/crm/deals/api/create.mdx (1 hunks)
• docs/crm/deals/api/get.mdx (1 hunks)
• docs/crm/deals/api/list.mdx (1 hunks)
• docs/crm/deals/api/update.mdx (1 hunks)
• docs/crm/deals/overview.mdx (1 hunks)
• docs/crm/engagements/api/create.mdx (1 hunks)
• docs/crm/engagements/api/get.mdx (1 hunks)
• docs/crm/engagements/api/list.mdx (1 hunks)
• docs/crm/engagements/api/update.mdx (1 hunks)
• docs/crm/notes/api/create.mdx (1 hunks)
• docs/crm/notes/api/get.mdx (1 hunks)
• docs/crm/notes/api/list.mdx (1 hunks)
• docs/crm/notes/api/update.mdx (1 hunks)
• docs/crm/tasks/api/get.mdx (1 hunks)
• docs/crm/tasks/api/list.mdx (1 hunks)
• docs/crm/tasks/api/update.mdx (1 hunks)
• docs/crm/users/api/get.mdx (1 hunks)
• docs/crm/users/api/list.mdx (1 hunks)
• docs/open-source/contributors.mdx (1 hunks)
• docs/ticketing/accounts/api/create.mdx (1 hunks)
• docs/ticketing/accounts/api/get.mdx (1 hunks)
• docs/ticketing/accounts/api/list.mdx (1 hunks)
• docs/ticketing/accounts/api/update.mdx (1 hunks)
• docs/ticketing/comments/api/list.mdx (1 hunks)
• docs/ticketing/comments/api/update.mdx (1 hunks)
• docs/ticketing/contacts/api/create.mdx (1 hunks)
• docs/ticketing/contacts/api/get.mdx (1 hunks)
• docs/ticketing/contacts/api/list.mdx (1 hunks)
• docs/ticketing/contacts/api/update.mdx (1 hunks)
• docs/ticketing/tags/api/get.mdx (1 hunks)
• docs/ticketing/tags/api/list.mdx (1 hunks)
• docs/ticketing/teams/api/get.mdx (1 hunks)
• docs/ticketing/teams/api/list.mdx (1 hunks)
• docs/ticketing/tickets/api/create.mdx (1 hunks)
• docs/ticketing/tickets/api/get.mdx (1 hunks)
• docs/ticketing/tickets/api/list.mdx (1 hunks)
• docs/ticketing/tickets/api/update.mdx (1 hunks)
• docs/ticketing/users/api/get.mdx (1 hunks)
• docs/ticketing/users/api/list.mdx (1 hunks)

Files skipped from review due to trivial changes (7)

• docs/crm/companies/api/list.mdx
• docs/crm/companies/overview.mdx
• docs/crm/contacts/api/list.mdx
• docs/crm/deals/api/get.mdx
• docs/crm/deals/overview.mdx
• docs/ticketing/comments/api/list.mdx
• docs/ticketing/users/api/get.mdx

Additional comments: 31

docs/crm/tasks/api/update.mdx (1)

• 1-3: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-4]

The front matter correctly specifies the OpenAPI operation as a PATCH request for updating a task.

docs/crm/companies/api/create.mdx (1)

• 1-4: The front matter correctly specifies the OpenAPI operation as a POST request for creating a company.

docs/crm/companies/api/get.mdx (1)

• 1-4: The front matter correctly specifies the OpenAPI operation as a GET request for retrieving a company by ID.

docs/crm/companies/api/update.mdx (1)

• 1-4: The front matter correctly specifies the OpenAPI operation as a PATCH request for updating a company.

docs/crm/deals/api/list.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for listing deals.

docs/crm/notes/api/list.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for listing notes.

docs/crm/tasks/api/list.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for listing tasks.

docs/crm/users/api/list.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for listing users.

docs/crm/deals/api/create.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a POST request for creating a deal.

docs/crm/notes/api/create.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a POST request for creating a note.

docs/crm/deals/api/update.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a PATCH request for updating a deal.

docs/crm/notes/api/update.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a PATCH request for updating a note.

docs/crm/tasks/api/get.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for retrieving a task by ID.

docs/ticketing/users/api/list.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for listing users in the ticketing platform.

docs/crm/notes/api/get.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for retrieving a note by ID.

docs/crm/users/api/get.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for retrieving a user by ID.

docs/ticketing/tags/api/list.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for listing all tags in the ticketing platform.

docs/crm/engagements/api/list.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for listing engagements.

docs/ticketing/tickets/api/list.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for listing tickets in the ticketing platform.

docs/ticketing/tags/api/get.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for retrieving a tag by ID in the ticketing platform.

docs/crm/engagements/api/create.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a POST request for creating an engagement.

docs/crm/engagements/api/update.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a PATCH request for updating an engagement.

docs/ticketing/contacts/api/create.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a POST request for creating a contact in the ticketing platform.

docs/ticketing/tickets/api/update.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a PATCH request for updating a ticket in the ticketing platform.

docs/ticketing/teams/api/get.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for retrieving a team by ID in the ticketing platform.

docs/ticketing/comments/api/update.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a PATCH request for updating a comment in the ticketing platform.

docs/ticketing/contacts/api/get.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for retrieving a contact in the ticketing platform.

docs/ticketing/contacts/api/update.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a PATCH request for updating a contact in the ticketing platform.

docs/ticketing/tickets/api/get.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for retrieving a ticket by ID in the ticketing platform.

docs/crm/engagements/api/get.mdx (1)

• 1-5: The front matter and description correctly specify the OpenAPI operation as a GET request for retrieving an engagement by ID.

docs/open-source/contributors.mdx (1)

• 30-34: The added instructions for removing previously installed dependencies are clear and should help contributors clean their environment before a build.