Skip to content

Commit

Permalink
populate getting-started section
Browse files Browse the repository at this point in the history
  • Loading branch information
oggnimodd committed Oct 18, 2023
1 parent 0fcc73d commit 9ea68c2
Show file tree
Hide file tree
Showing 13 changed files with 57 additions and 15 deletions.
7 changes: 2 additions & 5 deletions apps/docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { defineConfig, squooshImageService } from "astro/config";
import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";

// https://astro.build/config
Expand Down Expand Up @@ -41,7 +41,7 @@ export default defineConfig({
autogenerate: { directory: "additional-information" },
},
],
favicon: "/images/icon.svg",
favicon: "/images/icons/icon.svg",
customCss: [
// Relative path to your custom CSS file
"./src/styles/custom.css",
Expand All @@ -54,7 +54,4 @@ export default defineConfig({
noExternal: ["execa", "is-stream", "npm-run-path"],
},
},
image: {
service: squooshImageService(),
},
});
3 changes: 2 additions & 1 deletion apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@
"dependencies": {
"@astrojs/starlight": "0.11.1",
"astro": "^3.2.1"
}
},
"trustedDependencies": ["sharp"]
}
File renamed without changes
File renamed without changes
File renamed without changes
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 27 additions & 2 deletions apps/docs/src/content/docs/getting-started/download.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,31 @@
---
title: Download
description: How to download and install AI Chat Snippets on your browser
description: How to Download and Install AI Chat Snippets on Your Browser
---

[Download Link](https://github.com/oggnimodd/ai-prompt-snippets/releases/tag/1.0.0)
## Downloading the Extension

### Chrome Web Store
The extension is not yet available on the Chrome Web Store as it's currently undergoing review by Google, a standard procedure for all extensions seeking publication on the platform. This review process typically takes 1-2 weeks.

### Extension's GitHub release page
You can also download it from the release page of the extension's GitHub repository below:

[**Download Link**](https://github.com/oggnimodd/ai-prompt-snippets/releases/tag/1.0.0)

:::tip[What file to download?]
Visit the provided link and download the file named "**ai-prompt-snippets.zip**."
:::

## Installation

### Manual installation
Follow these steps to install the extension manually:

1. Download the "**ai-prompt-snippets.zip**" file and extract its contents.
2. Open your browser and navigate to chrome://extensions.
3. Enable Developer mode by clicking the toggle switch at the top right corner.
4. Click "Load unpacked."
5. Locate the folder where you extracted the extension files and select it.

<img src="/images/screenshots/manual-installation.gif" alt="Manual Installation"/>
6 changes: 0 additions & 6 deletions apps/docs/src/content/docs/getting-started/get-started.md

This file was deleted.

20 changes: 20 additions & 0 deletions apps/docs/src/content/docs/getting-started/get-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Introduction
description: Why this extension exists?
---

## Why do we need this extension?

AI assistants like [ChatGPT](https://openai.com/blog/chatgpt) and [Bard AI](https://bard.google.com/) are transforming how we interact with information, but the need to repeatedly type common prompts wastes time. Additionally, crafting prompts with specific context and formatting instructions can be tedious.

This chrome extension enables you to create libraries of reusable snippets containing custom questions, templates, and prompts. Instead of manually typing detailed queries multiple times, you can simply select the appropriate snippet and insert it into your chat with a single click.

## Examples

For instance, you can create an "Email" snippet with subject, recipient, body text, tone, and length parameters, allowing you to quickly generate AI-assisted email drafts. Similarly, a "Define" snippet can instantly provide word definitions and example sentences showcasing word usage.

### Email Snippet
<img src="/images/screenshots/showcase-email.gif" alt="Email snippet"/>

### Definition Snippet
<img src="/images/screenshots/showcase-definition.gif" alt="Definition snippet"/>
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,9 @@ title: Supported Platforms
description: What AI chat platforms are supported
---

Chat GPT (Open AI), Claude AI (Anthropic), Bard AI(Google), and Poe (Quora)
Our platform supports a variety of AI chat platforms, including:

- [Chat GPT](https://openai.com/blog/chatgpt) from OpenAI
- [Claude AI](https://www.anthropic.com/index/introducing-claude) from Anthropic
- [Bard AI](https://bard.google.com/) from Google
- [Poe](https://poe.com/) from Quora.
Binary file modified bun.lockb
Binary file not shown.

0 comments on commit 9ea68c2

Please sign in to comment.