search

deepgram / deepgram-dotnet-sdk

.NET SDK for Deepgram's automated speech recognition APIs.
https://developers.deepgram.com
MIT License
28 stars 32 forks source link

Update README for `v4` Release (Similar to Python README) #269

Closed dvonthenen closed 4 months ago

dvonthenen commented 5 months ago

This updates the README in preparation for the v4 release. This README is similar to the existing Python SDK README.

TODOs in another PR: Look into generating code docs from comments in code (similar to Go SDK). Issue: https://github.com/deepgram/deepgram-dotnet-sdk/issues/268

coderabbitai[bot] commented 5 months ago

Walkthrough

The recent update restructures the README.md file to enhance user accessibility and clarity. Key sections like API keys, requirements, and example codes have been prioritized in the document's layout. New sections including detailed quickstarts and logging instructions have been added, making it easier for users to get started and troubleshoot.

Changes

File Change Summary
README.md Reorganized for clarity: moved key sections to top, added "Quickstarts", "Example Code", and "Logging".
Recent Review Status **Configuration used: CodeRabbit UI**
Commits Files that changed from the base of the PR and between db50b7c2e12c869a41158dce1f465f3fd5b99007 and 0b7ce4a97b36e65c16c69f21f26230546b5048a6.
Files selected for processing (1) * README.md (1 hunks)
Additional Context Used
Learnings (1)
README.md (1)
``` User: dvonthenen" URL: https://github.com/deepgram/deepgram-dotnet-sdk/pull/260 Timestamp: 2024-04-04T01:29:14.054Z Learning: The Deepgram .NET SDK examples are designed to be self-contained to facilitate ease of understanding and use. Centralizing functionalities like JSON parsing options among various examples is not preferred. ```
Additional comments not posted (9)
README.md (9)
`3-15`: The restructuring of the introductory section and table of contents effectively prioritizes essential information, enhancing clarity and accessibility. --- `27-29`: The "Getting an API Key" section is clear and provides essential information upfront, which is beneficial for new users. --- `31-37`: The "Requirements" section effectively communicates the supported .NET versions, aiding users in verifying compatibility. --- `39-56`: The "Installation" section is well-organized, providing clear commands for installing the SDK and managing previous versions. --- `59-154`: The "Quickstarts" section is comprehensive, providing detailed guides and code examples for both pre-recorded and live audio transcription, which greatly facilitates user onboarding. --- `157-193`: The "Example Code" section is excellently organized, categorizing examples by API functionality and providing direct links, which enhances discoverability and usability. --- `198-210`: The "Logging" section provides clear instructions and code examples for configuring logging levels, which is valuable for debugging and troubleshooting. --- `216-219`: The "Development and Contributing" section effectively encourages community contributions and provides essential links to the Code of Conduct and Contribution guidelines. --- `223-227`: The "Getting Help" section is well-crafted, offering multiple channels for support, which enhances the accessibility and responsiveness of user assistance.
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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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.` 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. - 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.