Skip to content
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.

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

Create project homepage and documentation using docusaurus #39

Merged
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
20 changes: 20 additions & 0 deletions cllm-website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
41 changes: 41 additions & 0 deletions cllm-website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

### Installation

```
$ yarn
```

### Local Development

```
$ yarn start
devleejb marked this conversation as resolved.
Show resolved Hide resolved
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
3 changes: 3 additions & 0 deletions cllm-website/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions cllm-website/blog/2024-03-15-welcome/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
slug: welcome
title: Welcome
authors: [chanism]
tags: [welcome]
---

Hello and Welcome to the **CLLM** documentation!

CLLM is a **C**ommand **L**ine **L**arge Language **M**odel tool that is designed to help you write cli-command.
Currently, CLLM is based on **GPT-3.5 Turbo** Model, which is a large language model developed by OpenAI.

Below are the list of commands that you can use to interact with CLLM.
- `help` - To get the list of commands that you can use.
- `search` - To search for a specific command about your query.
- `set key` - To set the OPEN API key for using CLLM.
ykdy3951 marked this conversation as resolved.
Show resolved Hide resolved
- `history` - To get the history of (query, command) that you have used.

If you have any questions or need help, feel free to ask in the [CLLM Discord](https://discord.gg/sy9BhhdbJu).

![cllm-example-1](./cllm-example-1.gif)
5 changes: 5 additions & 0 deletions cllm-website/blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
chanism:
name: Chanwoong Kim
title: Maintainer of CLLM
ykdy3951 marked this conversation as resolved.
Show resolved Hide resolved
url: https://github.com/ykdy3951
image_url: https://github.com/ykdy3951.png
21 changes: 21 additions & 0 deletions cllm-website/community/0-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
sidebar_position: 1
---

# Support

## Community

We are building a community around CLLM and we would love for you to join us. You can find us on [Discord](https://discord.gg/8v3Gk3j) and follow us on [Twitter](https://twitter.com/devbackpacks) to stay up to date with the latest news and announcements.

## Issue Tracker

If you encounter a bug or have a question about CLLM, please open an issue on our [GitHub repository](https://github.com/dev-backpack/cllm/issues) and tag it with the `bug` label.

## Feature Requests

If you have an idea for a new feature or improvement to CLLM, please open an issue on our [GitHub repository](https://github.com/dev-backpack/cllm/issues) and tag it with the `improvement` label.

## News

For the latest news about CLLM, follow us on [Twitter](https://twitter.com/devbackpacks) and join our [Discord server](https://discord.gg/8v3Gk3j) and the [CLLM Blog](../blog).
21 changes: 21 additions & 0 deletions cllm-website/community/1-team.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
sidebar_position: 2
---

import {
ActiveTeamRow,
HonoraryAlumniTeamRow,
StudentFellowsTeamRow,
} from '@site/src/components/TeamProfileCards';

# Team

## Maintainers

The following individuals are responsible for maintaining the CLLM community and its projects

<ActiveTeamRow />




8 changes: 8 additions & 0 deletions cllm-website/community/2-contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Contributing
sidebar_position: 3
---

# Contributing to CLLM

CLLM is an open-source project and we welcome contributions from the community. We are currently working on a contribution guide and will update this page with more information soon. In the meantime, feel free to reach out to us on our [Discord server](https://discord.gg/8v3Gk3j) if you have any questions or would like to get involved.
Binary file added cllm-website/docs/cllm-example-1.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions cllm-website/docs/commands/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Commands",
"position": 3,
"link": {
"type": "generated-index",
"description": "Below is a list of CLLM commands and their usages"
}
}
13 changes: 13 additions & 0 deletions cllm-website/docs/commands/describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_position: 4
---

# describe

The `describe` command is used to display the description of a command.

## Usage

```bash
cllm describe <command>
```
25 changes: 25 additions & 0 deletions cllm-website/docs/commands/history.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_position: 3
---

# history

The `history` command is used to display the history of previous searches.

## Usage

```bash
cllm history --limit <limit> --offset <offset> --query <query>
```
or
```bash
cllm history -l <limit> -o <offset> -q <query>
```

## Options
<!-- table -->
| Option | Default | Description |
| --- | --- | -- |
| `--limit` or `-l` | `10` | Limit the number of results to display. |
| `--offset` or `-o` | `0` | Offset the results by a number. |
| `--query` or `-q` | `Optional` | Filter the results by a query. |
13 changes: 13 additions & 0 deletions cllm-website/docs/commands/search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_position: 2
---

# search

The `search` command is used to search for a command.

## Usage

```bash
cllm search <command>
```
18 changes: 18 additions & 0 deletions cllm-website/docs/commands/set/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
slug: /set
sidebar_position: 1
---

# set

Configure application resources.

These commands help you make changes to existing application resources.
Configure application resources.

These commands help you make changes to existing application resources.

Usage
```bash
$ cllm set <SUBCOMMAND>
```
14 changes: 14 additions & 0 deletions cllm-website/docs/commands/set/key.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
sidebar_position: 1
---

# key

The `key` command is used to set the API key for the LLM API.
ykdy3951 marked this conversation as resolved.
Show resolved Hide resolved

## Usage

### Set Key
```bash
cllm set key <API_KEY>
```
24 changes: 24 additions & 0 deletions cllm-website/docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_position: 2
---

# Getting Started

Welcome to the **CLLM** documentation! This guide will help you get started with **CLLM** and show you how to use it to improve your CLI experience.
ykdy3951 marked this conversation as resolved.
Show resolved Hide resolved

## Installation

To install **CLLM**, you can use the following command:

### Homebrew

```bash
brew tap dev-backpack/cllm
brew install cllm
```

### Install Script

```bash
curl -sSL https://raw.githubusercontent.com/dev-backpack/cllm/main/install.sh | sh
```
ykdy3951 marked this conversation as resolved.
Show resolved Hide resolved
10 changes: 10 additions & 0 deletions cllm-website/docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
sidebar_position: 1
---

# Introduction

Empower your CLI experience with a command search tool driven by **LLM magic**!

<!-- ./cllm-example-1.gif -->
![cllm-example-1](./cllm-example-1.gif)
Loading
Loading