Skip to content

Commit

Permalink
[DOCS][CLEANUP]
Browse files Browse the repository at this point in the history
  • Loading branch information
Kye committed Apr 25, 2024
1 parent fe5a318 commit 4fbd228
Show file tree
Hide file tree
Showing 4 changed files with 1,295 additions and 128 deletions.
File renamed without changes.
15 changes: 2 additions & 13 deletions docs/docker_setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Docker Setup Guide for Contributors to Swarms

## Introduction

Welcome to the `swarms` project Docker setup guide. This document will help you establish a Docker-based environment for contributing to `swarms`. Docker provides a consistent and isolated environment, ensuring that all contributors can work in the same settings, reducing the "it works on my machine" syndrome.

Expand All @@ -23,16 +22,6 @@ This guide covers:
- Running tests using Docker
- Pushing changes and working with Docker Hub

### Audience

This guide is intended for developers and contributors to the `swarms` project who have basic knowledge of version control with Git and programming in Python.

## Prerequisites

Before you begin, ensure you have:
- A GitHub account
- Git installed on your machine
- Basic command-line proficiency

## Docker Installation

Expand Down Expand Up @@ -143,6 +132,8 @@ RUN pip install --upgrade pip
RUN pip install --no-cache-dir -r requirements.txt

# Install the 'swarms' package, assuming it's available on PyPI
ENV SWARM_API_KEY=your_swarm_api_key_here
ENV OPENAI_API_KEY=your_openai_key
RUN pip install swarms

# Copy the rest of the application
Expand All @@ -156,8 +147,6 @@ COPY . .
# EXPOSE 5000

# Define environment variable for the swarm to work
ENV SWARM_API_KEY=your_swarm_api_key_here

# Add Docker CMD or ENTRYPOINT script to run the application
# CMD python your_swarm_startup_script.py
# Or use the entrypoint script if you have one
Expand Down
5 changes: 3 additions & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ nav:
- Limitations of Individual Agents: "limits_of_individual_agents.md"
- Build an Agent: "diy_your_own_agent.md"
- Build an Agent with tools: "examples/tools_agents.md"
- Docker Setup: docker_setup.md
- Swarms Cloud API:
- Overview: "swarms_cloud/main.md"
- Migrate from OpenAI to Swarms in 3 lines of code: "swarms_cloud/migrate_openai.md"
Expand Down Expand Up @@ -190,7 +191,7 @@ nav:
- Corporate:
- Corporate Documents:
- Data Room: "corporate/data_room.md"
- SwarmMemo: "corporate/swarm_memo.md"
- The Swarm Memo: "corporate/swarm_memo.md"
- Corporate Architecture: "corporate/architecture.md"
- Flywheel: "corporate/flywheel.md"
- Bounties: "corporate/bounties.md"
Expand All @@ -212,5 +213,5 @@ nav:
- Contributors:
- Contributing: "contributing.md"
- Why Swarms: "why_swarms.md"
- The Swarms Bounty System: "swarms_bounty_system.md"
- The Swarms Bounty System: "corporate/swarms_bounty_system.md"

Loading

0 comments on commit 4fbd228

Please sign in to comment.