diff --git a/README.md b/README.md index 3f650f04..426ce457 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/banner.png b/banner.png new file mode 100644 index 00000000..f7900dc0 Binary files /dev/null and b/banner.png differ diff --git a/fern/pages/get-started/contribute.mdx b/fern/pages/get-started/contribute.mdx new file mode 100644 index 00000000..756850db --- /dev/null +++ b/fern/pages/get-started/contribute.mdx @@ -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. \ No newline at end of file diff --git a/fern/v1.yml b/fern/v1.yml index f7d416b2..1b375561 100644 --- a/fern/v1.yml +++ b/fern/v1.yml @@ -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