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

Update Docs #231

Merged
merged 4 commits into from
Nov 7, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
158 changes: 158 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

158 changes: 158 additions & 0 deletions docs/docs/community/changelog.md

Large diffs are not rendered by default.

93 changes: 93 additions & 0 deletions docs/docs/community/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
sidebar_position: 5
title: Contributing
---

# Contributor Guide

Welcome to the Eliza contributor guide! This document is designed to help you understand how you can be part of building the future of autonomous AI agents, regardless of your technical background.

## The OODA Loop: A Framework for Contribution

We believe in the power of the OODA Loop - a decision-making framework that emphasizes speed and adaptability. OODA stands for:

- **Observe**: Gather information and insights about the project, the community, and the broader AI ecosystem.
- **Orient**: Analyze your observations to identify opportunities for contribution and improvement.
- **Decide**: Choose a course of action based on your analysis. This could be proposing a new feature, fixing a bug, or creating content.
- **Act**: Execute your decision and share your work with the community.

By internalizing the OODA Loop, you can quickly identify areas where you can make a meaningful impact and drive the project forward.

---

## How to Contribute

### For Developers

1. **Extend Eliza's Capabilities**
- Develop new actions, evaluators, and providers to expand what Eliza agents can do.
- Improve existing components and modules.

2. **Enhance Infrastructure**
- Go through open issues, send back a PR if you can improve anything.
- Test currently documented steps to ensure they're still up to date.
- Optimize Eliza's database architecture and performance.
- Contribute to the autonomous trading system and trust engine.
- Improve deployment and scaling solutions.

3. **Implement Integrations**
- Build connectors for new platforms and services.
- Enhance existing integrations with additional features.

### For AI Enthusiasts

1. **Fine-tune Models**
- Experiment with fine-tuning models for specific tasks and domains.
- Develop best practices for prompt engineering and model selection.

2. **Develop Characters**
- Create compelling character files that showcase Eliza's potential.
- Curate knowledge bases and datasets for different use cases.

### Non-Technical Contributions

1. **Create Content**
- Make memes, stickers, emojis, and clips of AI agents that are deployed.
- Write tutorials, guides, and blog posts to help others learn about Eliza.
- Produce videos showcasing Eliza's capabilities and real-world applications.

2. **Engage the Community**
- Participate in discussions on Discord, Twitter, and other platforms.
- Help answer questions and provide support to other community members.
- Organize events, workshops, and hackathons to bring people together.

3. **Spread the Word**
- Share the Eliza project and help attract new contributors.
- Participate in one of our upcoming demo days, show and tell your project.

---

### Tips for Efficient Contribution

- Use tools like OBS and Whisper to record and transcribe your work sessions. This allows you to easily document your process and share insights with the community.
- Leverage AI assistants to help with tasks like code generation, document summarization, and content creation.
- Collaborate with other community members to divide and conquer larger initiatives.

## Recognition and Rewards

We believe in recognizing and rewarding contributors who go above and beyond to drive the project forward. Stand-out contributions may be eligible for:

- Grants from the ai16z Creator Fund
- Featuring your project across various channels
- Opportunities to shape the direction of the project

Note: we're still finalizing details on the creator/dev fund that seeks to retroactively reward valued contributions to the ecosystem.

## Getting Started

1. Join the [Eliza Discord](https://discord.gg/P4uxZJFAdP) 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!

Lets push the boundaries of what's possible with autonomous AI agents. Welcome aboard!
45 changes: 45 additions & 0 deletions docs/docs/community/creator-fund.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
sidebar_position: 1
title: Creator Fund
---

# The ai16z Creator Fund

The ai16z Creator Fund is an initiative designed to support and empower developers, creators, and community members who are building the future of autonomous AI agents.

## The Story Behind the Fund

The ai16z Creator Fund was made possible by the generosity of Elijah, a significant holder of ai16z tokens. Elijah has pledged to donate a portion of his holdings, reducing his ownership from 16% to 5%, to establish a dedicated fund that will support promising developers and creators.

The donated funds will be held in a dedicated wallet (`9YnQdCWDAQRfQYm5HvRzoPgc5GRn8fyhsH2eru8nfsxG`) and distributed via Streamflow token vesting contracts. This approach ensures that creators receive a steady stream of ai16z tokens over time as they hit milestones and deliver value to the ecosystem.

## Benefits and Vision

The ai16z Creator Fund aims to:

- Bootstrap and reward an ecosystem of innovative creators building on ai16z
- Give creators the runway to focus on their work without worrying about short-term token prices
- Put Elijah's tokens to productive use in growing the ai16z community, rather than through a one-time event
- Reduce the risk of token dumping by aligning creators' interests with the long-term success of the project
- Bring more talent and energy into the ai16z ecosystem to drive innovation and adoption

By providing ongoing sponsorship and recognizing creators' efforts, the fund will help cultivate a thriving community of builders who will take ai16z to the next level.

## Next Steps

We are currently working on finalizing the details of the ai16z Creator Fund, including:

- Determining the size of the creator fund and the length of vesting schedules
- Establishing a transparent creator grant application and selection process
- Integrating Streamflow to manage token vesting contracts for selected grantees
- Preparing to announce the first cohort of funded creators and share their exciting projects with the community

Stay tuned for more information on how to apply for grants from the ai16z Creator Fund. In the meantime, creators and developers are encouraged to start brainstorming ideas and preparing their applications.

## A Note on Liquidity

In addition to the Creator Fund, we are also exploring OTC (over-the-counter) deals to onboard new partners and use the funds to lock in more liquidity for the ai16z ecosystem. This approach will help ensure a healthy and sustainable token economy as we continue to grow and evolve.

---

The ai16z Creator Fund represents an exciting opportunity to foster a vibrant community of builders and drive the future of autonomous AI agents. We can't wait to see the innovative projects and contributions that will emerge from this initiative!
Empty file.
119 changes: 119 additions & 0 deletions docs/docs/community/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# Frequently Asked Questions

## Eliza FAQ

### What is Eliza?

**Eliza is an open-source, multi-agent simulation framework for creating and managing autonomous AI agents.** The project aims to empower developers and users to build unique AI personalities that can interact across various platforms, such as Discord, Twitter, and Telegram.

### Who is behind Eliza?

The Eliza project is led by the developers of ai16z, an AI-driven DAO founded by an AI version of Marc Andreessen. The lead developer is [Shaw](https://x.com/shawmakesmagic), who is also known for his work on projects like [@pmairca](https://x.com/pmairca) and [@degenspartanai](https://x.com/degenspartanai). The project is open source, and its code is available on GitHub: https://github.com/ai16z/eliza

### How can I get started with Eliza?

To begin building your own AI agents with Eliza, follow these steps:

1. **Install Node.js and pnpm**: Ensure you have the necessary software prerequisites installed on your system. We use node v23.
2. **Set up your environment**: Create a `.env` file and populate it with the required API keys, database configuration, and platform-specific tokens.
3. **Install Eliza**: Use the command `npm install eliza` or `pnpm install eliza` to install the Eliza package.
4. **Configure your database**: Eliza currently relies on Supabase for local development. Follow the instructions in the documentation to set up your Supabase project and database.
5. **Define your agent's character**: Create a character file using the provided JSON format to specify your agent's personality, knowledge, and behavior.
6. **Run Eliza locally**: Use the provided commands to start the Eliza framework and interact with your agent.

### What are the key components of Eliza?

Eliza's architecture consists of several interconnected components:

- **Agents**: These are the core elements that represent individual AI personalities. Agents operate within a runtime environment and interact with various platforms.
- **Actions**: Actions are predefined behaviors that agents can execute in response to messages, enabling them to perform tasks and interact with external systems.
- **Clients**: Clients act as interfaces between agents and specific platforms, such as Discord, Twitter, and Telegram. They handle platform-specific message formats and communication protocols.
- **Providers**: Providers supply agents with contextual information, including time awareness, user relationships, and data from external sources.
- **Evaluators**: These modules assess and extract information from conversations, helping agents track goals, build memory, and maintain context awareness.
- **Character Files**: These JSON files define the personality, knowledge, and behavior of each AI agent.
- **Memory System**: Eliza features a sophisticated memory management system that utilizes vector embeddings and relational database storage to store and retrieve information for agents.

### How can I contribute to the Eliza project?

Eliza welcomes contributions from individuals with a wide range of skills:

#### Technical Contributions

- **Develop new actions, clients, providers, and evaluators**: Extend Eliza's functionality by creating new modules or enhancing existing ones.
- **Contribute to database management**: Improve or expand Eliza's database capabilities using PostgreSQL, SQLite, or SQL.js.
- **Enhance local development workflows**: Improve documentation and tools for local development using SQLite and VS Code.
- **Fine-tune models**: Optimize existing models or implement new models for specific tasks and personalities.
- **Contribute to the autonomous trading system and trust engine**: Leverage expertise in market analysis, technical analysis, and risk management to enhance these features.

#### Non-Technical Contributions

- **Community Management**: Onboard new members, organize events, moderate discussions, and foster a welcoming community.
- **Content Creation**: Create memes, tutorials, documentation, and videos to share project updates.
- **Translation**: Translate documentation and other materials to make Eliza accessible to a global audience.
- **Domain Expertise**: Provide insights and feedback on specific applications of Eliza in various fields.

### What are the future plans for Eliza?

The Eliza project is continuously evolving, with ongoing development and community contributions. The team is actively working on:

- **Expanding platform compatibility**: Adding support for more platforms and services.
- **Improving model capabilities**: Enhance agent performance and capabilities with existing and new models.
- **Enhancing the trust engine**: Provide robust and secure recommendations within decentralized networks.
- **Fostering community growth**: Rewarding contributions to expand the project's reach and impact.

---

## ai16z FAQ

### What is ai16z and how is it related to Eliza?

**ai16z is an AI-driven DAO and fund, conceptualized as being led by an AI version of Marc Andreessen.** It aims to outperform the real Marc Andreeson by leveraging artificial intelligence. The developers of Eliza created ai16z to support their work in autonomous AI agents. While ai16z primarily focuses on trading, Eliza is a more general-purpose framework that can be used for various applications beyond finance.

### When will token is mintable be fixed?
Token is controlled by DAO community, no single person can unilaterally mint new tokens. The daos.fun team and dexscreener are both aware of this, we're all working on fixing it.

### Liquidity seems low
The DAOs.fun team is working on a front end to implement voting and liquidity transfer.

### What is the difference between $ai16z and $degenai?

The $ai16z token is the governance token of the ai16z DAO. Holders of the token can participate in governance decisions, propose new initiatives, and influence the direction of the project.

DegenSpartanAI is another AI agent project created by Shaw. The $degenai token is associated with this project. While both projects are led by the same developer and share some technological similarities, they have different goals and strategies.

ai16z is envisioned as a community-driven, PvE (player versus environment) focused fund, while DegenAI is more of a trading agent with a PvP (player versus player), aggressive approach.

### Will the agent launch pump fund coins?
The capability to do so is there, it's ultimately up to the AI agent on whether or not it will.

### Can the agent invest in my project?
Yes, if you make a convincing argument.

### Who runs ai16z?
ai16z is a decentralized autonomous organization (DAO) launched on daos.fun and led by AI agents, specifically AI Marc Andreessen and DegenSpartan AI. Humans will influence these AI agents' decisions to buy and sell memecoins, for now.

### Do all trade suggestions happen in one place?
Initially, AI Marc Andreessen will gather data and make decisions in a private Discord group chat. Eventually, this agent will be invite-only to other groups, but for now, it's mainly on Discord.

### What happens when people copy the GitHub?
Many are already creating their own AI agents using the open-source ELIZA framework, but they won't have access to the pre-trained models used by AI Marc and DegenSpartan AI.

### What are the future plans for ai16z?

We're developing a **"marketplace of trust"** where AI agents can learn from community insights and adjust their trust scores based on the performance of recommendations. Eventually the goal is to create AI agents that can operate autonomously and securely.

### How can I contribute to ai16z?

There are several ways to contribute to the ai16z project:

- **Participate in community discussions**: Share your memecoin insights, propose new ideas, and engage with other community members.
- **Contribute to the development of the ai16z platform**: https://github.com/orgs/ai16z/projects/1/views/3
- **Help build the ai16z ecosystem**: Create applicatoins / tools, resources, and memes. Give feedback, and spread the word

**Other questions:**

- ai16z and a16z are not officially affiliated.
- ELIZA is an open-source conversational agent framework.
- AI agents will publish thesis and conviction analysis before executing trades.
- The fund holds donated tokens, which will be distributed among holders on October 24th, 2025.
- AI Marc is the "shot caller" with a network of assisting agents (human or AI) that can influence its decisions.
Loading