Skip to content

Commit

Permalink
feat(docs): initial version
Browse files Browse the repository at this point in the history
  • Loading branch information
arielweinberger committed Oct 20, 2023
1 parent e03a5b6 commit b33126b
Show file tree
Hide file tree
Showing 61 changed files with 21,773 additions and 12,217 deletions.
4 changes: 2 additions & 2 deletions apps/demo/app/layout.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ export default function RootLayout({
<div className="h-full max-h-screen flex flex-col p-12">
<div className="flex-grow overflow-y-auto">{children}</div>
<footer className="h-14 mt-6 text-center flex items-center justify-center text-stone-400">
Uni-LLM 🦄 - One API to rule them all!{" "}
UniLLM 🦄 - Consume any LLM from any provider, using the OpenAI API
<a
className="ml-2 font-semibold text-emerald-400 underline"
href="https://github.com/pezzolabs/Uni-LLM"
href="https://github.com/pezzolabs/UniLLM"
>
Check us out on GitHub!
</a>
Expand Down
Binary file added apps/docs/.github/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions apps/docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.next
node_modules
21 changes: 21 additions & 0 deletions apps/docs/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Pezzo, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
33 changes: 12 additions & 21 deletions apps/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,23 @@
# Mintlify Starter Kit
# Nextra Docs Template

Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
This is a template for creating documentation with [Nextra](https://nextra.site).

- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components
[**Live Demo →**](https://nextra-docs-template.vercel.app)

### Development
[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
## Quick Start

```
npm i -g mintlify
```
Click the button to clone this repository and deploy it on Vercel:

Run the following command at the root of your documentation (where mint.json is)
[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)

```
mintlify dev
```
## Local Development

### Publishing Changes
First, run `pnpm i` to install the dependencies.

Install our Github App to autopropagate changes from youre repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.
Then, run `pnpm dev` to start the development server and visit localhost:3000.

#### Troubleshooting
## License

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
This project is licensed under the MIT License.
3 changes: 0 additions & 3 deletions apps/docs/_snippets/snippet-example.mdx

This file was deleted.

22 changes: 0 additions & 22 deletions apps/docs/api-reference/authentication.mdx

This file was deleted.

84 changes: 0 additions & 84 deletions apps/docs/api-reference/endpoint/create.mdx

This file was deleted.

47 changes: 0 additions & 47 deletions apps/docs/api-reference/endpoint/delete.mdx

This file was deleted.

101 changes: 0 additions & 101 deletions apps/docs/api-reference/endpoint/get.mdx

This file was deleted.

Loading

0 comments on commit b33126b

Please sign in to comment.