panoratech / Panora

One API to connect your data sources to your LLMs
https://docs.panora.dev
Apache License 2.0
945 stars 193 forks source link

Update quick-start.mdx: corrected typo. for "software" #711

Closed saad-akhtar26 closed 5 days ago

saad-akhtar26 commented 2 weeks ago

On line 35, in sub-step 4 of step 1 (Getting access to your users data) there was a typographical mistake for word "software" Wrong: sofwtare Corrected as: software Kindly approve this simple typo. fix.

Summary by CodeRabbit

changeset-bot[bot] commented 2 weeks ago

⚠️ No Changeset found

Latest commit: 62d7241fcd6842dec7fe13553ea00ca42e501aa1

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.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

CLAassistant commented 2 weeks ago

CLA assistant check
All committers have signed the CLA.

coderabbitai[bot] commented 2 weeks ago
📝 Walkthrough ## Walkthrough The changes in this pull request focus on the `docs/quick-start.mdx` file, which includes minor spelling and punctuation corrections, such as changing "sofwtare" to "software." Additionally, there are formatting adjustments to improve spacing and clarity, while the overall structure and content of the Quickstart Guide remain unchanged. The document continues to provide comprehensive instructions, including prerequisites and steps for using the API. ## Changes | File | Change Summary | |--------------------------|-----------------------------------------------------| | docs/quick-start.mdx | Corrected spelling and punctuation; adjusted formatting for clarity. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant Quickstart Guide User->>Quickstart Guide: Access Quickstart Instructions Quickstart Guide-->>User: Display Prerequisites and Steps User->>Quickstart Guide: Follow Steps for API Access Quickstart Guide-->>User: Provide Next Steps and Resources ```

📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: ASSERTIVE**
📥 Commits Reviewing files that changed from the base of the PR and between 5888e8fc5ba37d7aca8bf6abb92f02d5670eaef2 and 62d7241fcd6842dec7fe13553ea00ca42e501aa1.
📒 Files selected for processing (1) * `docs/quick-start.mdx` (2 hunks)
🔇 Additional comments (2)
docs/quick-start.mdx (2) `35-35`: **LGTM! Spelling correction is accurate.** The change fixes the typo by correctly spelling "software" instead of "sofwtare". --- `133-133`: **LGTM! Documentation addition is valuable.** The added line appropriately references the TypeScript SDK documentation, enhancing the "Suggested Next Steps" section.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `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 generate unit testing code 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 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 generate unit testing code.` - `@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.` 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 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` or `@coderabbitai title` 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
zeropath-ai[bot] commented 2 weeks ago

No security or compliance issues detected. Reviewed everything up to 62d7241fcd6842dec7fe13553ea00ca42e501aa1.

Security Overview - 🔎 **Scanned files:** 1 changed file(s)
Detected Code Changes | Change Type | Relevant files | |------------|----------------| | Bug Fix | ► quick-start.mdx
    Fix typo: corrected "sofwtare" to "software" |

Reply to this PR with @zeropath-ai followed by a description of what change you want and we'll auto-submit a change to this PR to implement it.