update discord links, consolidate basic usage / installation / quickstart, update frontpage

Author: madjin

docs/backup_docusaurus.config.js

@@ -85,7 +85,7 @@ Note: we're still finalizing details on the creator/dev fund that seeks to retro
 
 ## Getting Started
 
-1. Join the [Eliza Discord](https://discord.gg/P4uxZJFAdP) and make a short introduction.
+1. Join the [Eliza Discord](https://discord.gg/ai16z) and make a short introduction.
 2. Explore the [documentation](/docs/intro) to understand the project's architecture and capabilities. 
 3. Check out the [open issues](https://github.com/ai16z/eliza/issues) on GitHub to find ways to contribute.
 4. Share your ideas and initiatives with the community - we're excited to see what you'll build!

docs/docs/community/contributing.md

@@ -2,112 +2,151 @@
 sidebar_position: 2
 ---
 
-# Quickstart
+# Quickstart Guide
 
-## Install Node.js
+## Prerequisites
 
-https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
+Before getting started with Eliza, ensure you have:
 
-## Using pnpm
+- [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- [pnpm](https://pnpm.io/installation)
+- Git for version control
+- A code editor (VS Code recommended)
+- CUDA Toolkit (optional, for GPU acceleration)
 
-We use pnpm to manage our dependencies. It is faster and more efficient than npm, and it supports workspaces.
-https://pnpm.io/installation
+## Installation
 
-## Edit the .env file
+1. **Clone and Install**
+```bash
+# Clone the repository
+git clone https://github.com/ai16z/eliza.git
+cd eliza
 
-- Copy .env.example to .env and fill in the appropriate values
-- Edit the TWITTER environment variables to add your bot's username and password
-
-## Edit the character file
+# Install dependencies
+pnpm install
 
-- Check out the file `src/core/defaultCharacter.ts` - you can modify this
-- You can also load characters with the `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` and run multiple bots at the same time.
+# Install optional Sharp package if needed
+pnpm install --include=optional sharp
+```
 
-### Run with Llama
+2. **Configure Environment**
+```bash
+# Copy example environment file
+cp .env.example .env
+```
 
-You can run Llama 70B or 405B models by setting the `XAI_MODEL` environment variable to `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` or `meta-llama/Meta-Llama-3.1-405B-Instruct`
+Edit `.env` and add your values:
+```bash
+# Required environment variables
+DISCORD_APPLICATION_ID=  # For Discord integration
+DISCORD_API_TOKEN=      # Bot token
+OPENAI_API_KEY=        # OpenAI API key (starting with sk-*)
+ELEVENLABS_XI_API_KEY= # API key from elevenlabs (for voice)
+```
 
-### Run with Grok
+## Choose Your Model
 
-You can run Grok models by setting the `XAI_MODEL` environment variable to `grok-beta`
+Eliza supports multiple AI models:
 
-### Run with OpenAI
+- **Llama**: Set `XAI_MODEL=meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo`
+- **Grok**: Set `XAI_MODEL=grok-beta`
+- **OpenAI**: Set `XAI_MODEL=gpt-4o-mini` or `gpt-4o`
 
-You can run OpenAI models by setting the `XAI_MODEL` environment variable to `gpt-4o-mini` or `gpt-4o`
+For local inference:
+1. Set `XAI_MODEL` to your chosen model
+2. Leave `X_SERVER_URL` and `XAI_API_KEY` blank
+3. The system will automatically download the model from Hugging Face
 
-# Requires Node 20+
+## Create Your First Agent
 
-If you are getting strange issues when starting up, make sure you're using Node 20+. Some APIs are not compatible with previous versions. You can check your node version with `node -v`. If you need to install a new version of node, we recommend using [nvm](https://github.com/nvm-sh/nvm).
+1. **Edit the Character File**
+Check out `src/core/defaultCharacter.ts` to customize your agent's personality and behavior.
 
-## Additional Requirements
+You can also load custom characters:
+```bash
+pnpm start --characters="path/to/your/character.json"
+```
 
-You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
+2. **Start the Agent**
+```bash
+pnpm start
+```
 
+## Platform Integration
+
+### Discord Bot Setup
+1. Create a new application at [Discord Developer Portal](https://discord.com/developers/applications)
+2. Create a bot and get your token
+3. Add bot to your server using OAuth2 URL generator
+4. Set `DISCORD_API_TOKEN` and `DISCORD_APPLICATION_ID` in your `.env`
+
+### Twitter Integration
+Add to your `.env`:
+```bash
+TWITTER_USERNAME=  # Account username
+TWITTER_PASSWORD=  # Account password
+TWITTER_EMAIL=    # Account email
+TWITTER_COOKIES=  # Account cookies
 ```
-pnpm install --include=optional sharp
+
+### Telegram Bot
+1. Create a bot through [@BotFather](https://t.me/botfather)
+2. Add your bot token to `.env`:
+```bash
+TELEGRAM_BOT_TOKEN=your_token_here
 ```
 
-# Environment Setup
+## Optional: GPU Acceleration
 
-You will need to add environment variables to your .env file to connect to various platforms:
+If you have an NVIDIA GPU:
 
-```
-# Required environment variables
-# Start Discord
-DISCORD_APPLICATION_ID=
-DISCORD_API_TOKEN= # Bot token
-
-# Start Twitter
-TWITTER_USERNAME= # Account username
-TWITTER_PASSWORD= # Account password
-TWITTER_EMAIL= # Account email
-TWITTER_COOKIES= # Account cookies
-```
-
-# Local Setup
+```bash
+# Install CUDA support
+npx --no node-llama-cpp source download --gpu cuda
 
-## CUDA Setup
+# Ensure CUDA Toolkit, cuDNN, and cuBLAS are installed
+```
 
-If you have an NVIDIA GPU, you can install CUDA to speed up local inference dramatically.
+## Basic Usage Examples
 
+### Chat with Your Agent
+```bash
+# Start chat interface
+pnpm run shell
 ```
-pnpm install
-npx --no node-llama-cpp source download --gpu cuda
+
+### Run Multiple Agents
+```bash
+pnpm start --characters="agent1.json,agent2.json"
 ```
 
-Make sure that you've installed the CUDA Toolkit, including cuDNN and cuBLAS.
+## Common Issues & Solutions
 
-## Running locally
+1. **Node.js Version**
+   - Ensure Node.js 22+ is installed
+   - Use `node -v` to check version
+   - Consider using [nvm](https://github.com/nvm-sh/nvm) to manage Node versions
 
-Add XAI_MODEL and set it to one of the above options from [Run with
-Llama](#run-with-llama) - you can leave X_SERVER_URL and XAI_API_KEY blank, it
-downloads the model from huggingface and queries it locally
+2. **Sharp Installation**
+   If you see Sharp-related errors:
+   ```bash
+   pnpm install --include=optional sharp
+   ```
 
-# Cloud Setup (with OpenAI)
+3. **CUDA Setup**
+   - Verify CUDA Toolkit installation
+   - Check GPU compatibility
+   - Ensure proper environment variables are set
 
-In addition to the environment variables above, you will need to add the following:
+## Next Steps
 
-```
-# OpenAI handles the bulk of the work with chat, TTS, image recognition, etc.
-OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk-
-
-# The agent can also ask Claude for help if you have an API key
-ANTHROPIC_API_KEY=
-
-# For Elevenlabs voice generation on Discord voice
-ELEVENLABS_XI_API_KEY= # API key from elevenlabs
-
-# ELEVENLABS SETTINGS
-ELEVENLABS_MODEL_ID=eleven_multilingual_v2
-ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
-ELEVENLABS_VOICE_STABILITY=0.5
-ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9
-ELEVENLABS_VOICE_STYLE=0.66
-ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false
-ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4
-ELEVENLABS_OUTPUT_FORMAT=pcm_16000
-```
+Once you have your agent running, explore:
+
+1. 🤖 [Understand Agents](./core/agents.md)
+2. 📝 [Create Custom Characters](./core/characterfile.md)
+3. ⚡ [Add Custom Actions](./core/actions.md)
+4. 🔧 [Advanced Configuration](./guides/configuration.md)
 
-# Discord Bot
+For detailed API documentation, troubleshooting, and advanced features, check out our [full documentation](https://ai16z.github.io/eliza/).
 
-For help with setting up your Discord Bot, check out here: https://discordjs.guide/preparations/setting-up-a-bot-application.html
+Join our [Discord community](https://discord.gg/ai16z) for support and updates!