Skip to content

Add API support for OpenAI and Groq, update README, and create long-form guide #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ghost wants to merge 1 commit into from
Closed

Add API support for OpenAI and Groq, update README, and create long-form guide #307

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 13 additions & 99 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,103 +1,17 @@
# Daytona
# AI Transcription Tool

<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/daytonaio/daytona/raw/main/assets/images/Daytona-logotype-white.png">
<img alt="Daytona logo" src="https://github.com/daytonaio/daytona/raw/main/assets/images/Daytona-logotype-black.png" width="40%">
</picture>
</div>
## Supported APIs
- OpenAI
- Groq

<div align="center">
## Installation
1. Clone the repository
2. Install dependencies
3. Configure API keys

[![Issues - Content](https://img.shields.io/github/issues/daytonaio/content)](https://github.com/daytonaio/content/issues)
[![Vaunt Community](https://api.vaunt.dev/v1/github/entities/daytonaio/repositories/content/badges/community)](https://community.vaunt.dev/board/daytonaio/repository/content)
## Usage
1. Import the API module
2. Call the transcription function

</div>

# Daytona Content Programme for Technical Writers

Welcome to the [Daytona](https://www.daytona.io) `content` repository! This repo
is dedicated to managing external technical writers who contribute articles and
guides. Here, you'll find details on how to participate, contribute, and get
compensated for your work.

## Table of Contents

- [Daytona Content Programme for Technical Writers](#daytona-content-programme-for-technical-writers)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [Where to Start](#where-to-start)
- [Licensing and Copyright](#licensing-and-copyright)
- [Payment](#payment)
- [Contact and Support](#contact-and-support)
- [Showcase Your Contributions](#showcase-your-contributions)
- [Top Contributors](#top-contributors)

# Introduction

The `content` repository is a platform where technical writers can contribute
articles to the [Daytona Dotfiles Insider](https://www.daytona.io/dotfiles/)
blog by "solving" posted issues (proposed article ideas) through pull requests.
Merged PRs are eligible for compensation.

> **Note:** Always use GitHub as the main communication channel. For questions
> not directly related to the project or for general clarifications, join the
> designated `content` channel on the Daytona Community Slack.

## Where to Start

Please refer to our [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed
information on how to contribute to this project.

## Licensing and Copyright

By contributing to this repository, you agree that all content you submit is
subject to the terms outlined in the [CONTRIBUTING.md](CONTRIBUTING.md) file.

## Payment

- Compensation is provided for accepted and published content.
- Payment can be made through Algora as bounties (if assigned to the issue and
your PR gets merged).

## Contact and Support

- For questions or assistance, open an issue or contact the repo maintainers.
- Join `#content` channel in our [Slack community](https://go.daytona.io/slack)
for discussions and support.

## Showcase Your Contributions

Along with the chance to earn bounties, each engagement comes with an
achievement badge.

Showcase your contributions in your GitHub profile and display your achievements
with pride! For more information, check the
[CONTRIBUTING.md](CONTRIBUTING.md#showcase-your-contributions) file.

### Top Contributors

<p>
<img src="https://api.vaunt.dev/v1/github/entities/daytonaio/repositories/content/contributors?format=svg&limit=10" width="600" />
</p>

You can showcase your achievement badges on your GitHub profile in the following
way:

<p>
<img src="https://api.vaunt.dev/v1/github/entities/nkkko/achievements?format=svg&limit=3" width="400" />
</p>

Simply add the following code to your GitHub profile README file:

```html
<p>
<img
src="https://api.vaunt.dev/v1/github/entities/USERNAME/achievements?format=svg&limit=3"
width="400"
/>
</p>
```

Happy writing, and thank you for contributing to the Daytona Dotfiles Insider
blog!
## Guide
For detailed instructions on how to use the API support, please refer to the [long-form guide](articles/20241212_long_form_guide.md).
16 changes: 16 additions & 0 deletions articles/20241212_long_form_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Long-Form Guide to Using the AI Transcription Tool

## Introduction
This guide will walk you through the process of using the AI Transcription Tool with OpenAI and Groq APIs.

## Step 1: Installation
1. Clone the repository
2. Install dependencies
3. Configure API keys

## Step 2: Usage
1. Import the API module
2. Call the transcription function

## Conclusion
By following this guide, you should now be able to use the AI Transcription Tool with OpenAI and Groq APIs.