Skip to content

Commit

Permalink
Add readme (#56)
Browse files Browse the repository at this point in the history
* Add readme

* Update README.md

Co-authored-by: Michael <[email protected]>
Signed-off-by: billytrend-cohere <[email protected]>

* Update README.md

Co-authored-by: Michael <[email protected]>
Signed-off-by: billytrend-cohere <[email protected]>

* Add contribute page

* Update fern/pages/get-started/contribute.mdx

Signed-off-by: billytrend-cohere <[email protected]>

---------

Signed-off-by: billytrend-cohere <[email protected]>
Co-authored-by: Michael <[email protected]>
  • Loading branch information
billytrend-cohere and mkozakov authored Aug 20, 2024
1 parent fd231f6 commit 06a2a2c
Show file tree
Hide file tree
Showing 4 changed files with 50 additions and 4 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
> [!WARNING]
> This repo will eventually be public
![](./banner.png)

# Cohere Developer Experience

At Cohere we aim to maximize developer productivity by meeting developers at their existing workflows: whether you want to use our model on our platform or on an external cloud platform, our aim is to provide the best experience available.

This repository is a one-stop-shop for Cohere developer experience. Here you can find docs, snippets, api specs and more to help you develop on the Cohere platform, or on AWS, Azure, OCI, or cohere-toolkit.

## How to use this repository

This repository is organized into the following sections:

- `fern/` contains content and configuration for https://docs.cohere.com
- `cohere-openapi.yaml` contains the OpenAPI spec for the Cohere platform API
- `snippets/` contains code snippets for using Cohere in various environments

## Other developer resources

### SDKs

We support the following SDKs which can be used to interact with the Cohere platform and cloud providers:

- [Python](https://github.com/cohere-ai/cohere-python)
- [Typescript](https://github.com/cohere-ai/cohere-typescript)
- [Java](https://github.com/cohere-ai/cohere-java)
- [golang](https://github.com/cohere-ai/cohere-go)


## How to contribute to this repository

We welcome contributions to this repository! Feel free to pull request any of the content you see and we will work with you to merge it. The OpenAPI sepcs and snippets are one-way synced from our internal repositories so we will need to take your changes and merge them behind the scenes.

# cohere-developer-experience
Docs, Snippets, Guides
Binary file added banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions fern/pages/get-started/contribute.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Improve Cohere Docs"
slug: "docs/contribute"

hidden: false
description: "Contribute to Cohere documentation"
image: "../../assets/images/be1a6fb-cohere_meta_image.jpg"
keywords: "cohere, documentation, contribute, open-source"
createdAt: "Tue Aug 20 2024 20:10:53 GMT+0000 (Coordinated Universal Time)"
updatedAt: "Tue Aug 20 2024 20:10:53 GMT+0000 (Coordinated Universal Time)"
---

All our docs content is stored in https://github.com/cohere-ai/cohere-developer-experience/.

We welcome contributions to this repo! Feel free to pull request any of the content you see and we will work with you to merge it. The OpenAPI specs and snippets are one-way synced from our internal repositories so we will need to take your changes and merge them behind the scenes.

Please see the repository readme for more guidance.
2 changes: 2 additions & 0 deletions fern/v1.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@ navigation:
path: pages/get-started/cohere-toolkit.mdx
- page: Datasets
path: pages/get-started/datasets.mdx
- page: Improve Cohere Docs
path: pages/get-started/contribute.mdx
- section: Models
contents:
- page: Models Overview
Expand Down

0 comments on commit 06a2a2c

Please sign in to comment.