Skip to content

Commit

Permalink
feat(docs): Update introduction and configuration
Browse files Browse the repository at this point in the history
- Updated the introduction in `docs/intro.md` to provide a better overview of Volvox.Apollo and its features.
- Removed unnecessary files related to tutorials and translations.
- Updated the Twitter link in `docusaurus.config.ts` to point to the correct account.
- Modified the button text in `src/pages/index.tsx` to reflect Volvox.Apollo instead of Docusaurus.

This commit improves the documentation by providing clearer information about Volvox.Apollo and removing irrelevant tutorial content.
  • Loading branch information
BillChirico committed Nov 6, 2023
1 parent c5914b8 commit c7c27ff
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 213 deletions.
52 changes: 15 additions & 37 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,24 @@
sidebar_position: 1
---

# Tutorial Intro
# Introduction

Let's discover **Docusaurus in less than 5 minutes**.
Hello there! We are thrilled to have you here.
The Volvox.Apollo API is designed to be developer focused and help you create your own integrations to protect your community.
Whether you are a seasoned developer or just getting started, this documentation is structured to provide you with the information you need to work effectively with Volvox.Apollo.

## Getting Started
## What is Volvox.Apollo?

Get started by **creating a new site**.
Apollo's API provides the flexibility to build the right customer experience for your business with developer-focused APIs and documentation for seamless integration and management.

Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
At the heart of Apollo lies a powerful message analysis engine designed to thoroughly evaluate messages precisely. Apollo assigns scores between 0 and 100 while utilizing a sophisticated AI model that enables a nuanced understanding of the message context and intent. Our robust models are finely tuned to identify and prevent a spectrum of inappropriate behaviors effectively. The inappropriate behaviors include:

### What you'll need
- Toxicity & Severe Toxicity
- Identity Attacks
- Sexual Harassment
- Unwanted Flirtation
- Insults, Offensive Language, & Statments Designed to Incite Anger
- Threats
- Spam

- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.

## Generate a new site

Generate a new Docusaurus site using the **classic template**.

The classic template will automatically be added to your project after you run the command:

```bash
npm init docusaurus@latest my-website classic
```

You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.

The command also installs all necessary dependencies you need to run Docusaurus.

## Start your site

Run the development server:

```bash
cd my-website
npm run start
```

The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.

Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
Apollo is committed to fostering safe, respectful, and professional digital interactions. This empowers users and administrators to maintain environments free from harassment and negativity.
23 changes: 0 additions & 23 deletions docs/tutorial-basics/congratulations.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/tutorial-extras/_category_.json

This file was deleted.

Binary file removed docs/tutorial-extras/img/docsVersionDropdown.png
Binary file not shown.
Binary file removed docs/tutorial-extras/img/localeDropdown.png
Binary file not shown.
55 changes: 0 additions & 55 deletions docs/tutorial-extras/manage-docs-versions.md

This file was deleted.

88 changes: 0 additions & 88 deletions docs/tutorial-extras/translate-your-site.md

This file was deleted.

2 changes: 1 addition & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ const config: Config = {
},
{
label: 'Twitter',
href: 'https://twitter.com/docusaurus',
href: 'https://twitter.com/volvoxllc',
},
],
},
Expand Down
4 changes: 2 additions & 2 deletions src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ function HomepageHeader() {
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Docusaurus Tutorial - 5min ⏱️
Volvox.Apollo Docs Tutorial
</Link>
</div>
</div>
Expand All @@ -33,7 +33,7 @@ export default function Home(): JSX.Element {
return (
<Layout
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />">
description="Documentation for Volvox.Apollo">
<HomepageHeader />
<main>
<HomepageFeatures />
Expand Down

0 comments on commit c7c27ff

Please sign in to comment.