Skip to content

sets up docs page#396

Closed
kevoconnell wants to merge 0 commit into8ball030:mainfrom
ExploreLabsxyz:main
Closed

sets up docs page#396
kevoconnell wants to merge 0 commit into8ball030:mainfrom
ExploreLabsxyz:main

Conversation

@kevoconnell
Copy link
Collaborator

@kevoconnell kevoconnell commented Jan 2, 2025

Copy link
Owner

@8ball030 8ball030 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great great effort, heroic in fact however quite a few feedback points where stuff has been halucinated

Comment on lines 84 to 86
echo 'export BLOCK_EXPLORER_API_KEY="your_api_key"' >> ~/.bashrc
echo 'export BLOCK_EXPLORER_URL="your_explorer_url"' >> ~/.bashrc
source ~/.bashrc
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we would rather add to a .env

Comment on lines 92 to 174
1. Create a systemd service file:
```ini
[Unit]
Description=Auto Dev Service
After=network.target

[Service]
Type=simple
User=autodev
Environment=BLOCK_EXPLORER_API_KEY=your_api_key
Environment=BLOCK_EXPLORER_URL=your_explorer_url
WorkingDirectory=/home/autodev/auto_dev
ExecStart=/usr/local/bin/adev your_command
Restart=always

[Install]
WantedBy=multi-user.target
```

2. Enable and start the service:
```bash
sudo systemctl enable autodev
sudo systemctl start autodev
```

### Monitoring
Monitor your deployment using:
```bash
sudo systemctl status autodev
journalctl -u autodev -f
```

## Docker Deployment (Optional)

While auto_dev doesn't currently provide official Docker images, you can containerize your auto_dev projects using this example configuration:

1. Create a Dockerfile:
```dockerfile
FROM python:3.11-slim

# Install system dependencies
RUN apt-get update && apt-get install -y \
git \
&& rm -rf /var/lib/apt/lists/*

# Install auto_dev
RUN pip install autonomy-dev[all]

# Set working directory
WORKDIR /app

# Copy your project files
COPY . .

# Set environment variables
ENV BLOCK_EXPLORER_API_KEY=your_api_key
ENV BLOCK_EXPLORER_URL=your_explorer_url

# Run your command
CMD ["adev", "your_command"]
```

2. Build and run:
```bash
docker build -t auto_dev .
docker run -e BLOCK_EXPLORER_API_KEY=your_key auto_dev
```

### Docker Compose
For more complex setups, use docker-compose:

```yaml
version: '3'
services:
auto_dev:
build: .
environment:
- BLOCK_EXPLORER_API_KEY=${BLOCK_EXPLORER_API_KEY}
- BLOCK_EXPLORER_URL=${BLOCK_EXPLORER_URL}
volumes:
- .:/app
```

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is all factually incorrect

3. **Service Issues**
```bash
# Check service logs
journalctl -u autodev -n 100
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do? We already generate docker-compose configurations as part of the run_mas.sh script?

docs/index.md Outdated
Comment on lines 1 to 16
# Project Status Badges

[![Code Quality](https://github.com/8ball030/auto_dev/actions/workflows/common_check.yaml/badge.svg)](https://github.com/8ball030/auto_dev/actions/workflows/common_check.yaml)


# Autonomy Dev

Tooling to speed up open-autonomy development.


## TLDR

```bash
# install
pip install autonomy-dev[all]
```
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this entire page is a duplication of the readme right?
Can we instead reference the read me to avoid duplication which will immeidately lead to issues

# Create a repo & a simple webserver agent
adev repo scaffold fun_new_hack && \
cd fun_new_hack && \
adev create author/cool_agent \
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lets ensure that publish command group is much better @xiuxiuxar can you please look at this one?
Its the piblish command which is currently causing stuff to fall over anyhow

docs/usage.md Outdated
2. **Dependency Management**
```bash
# Update specific dependencies
adev deps update -p . --packages "package1,package2"
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not an existing flag

docs/usage.md Outdated
adev deps update -p . --packages "package1,package2"

# Check for outdated dependencies
adev deps check -p .
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not a cli group, but could be!

docs/usage.md Outdated
adev deps check -p .

# Update all dependencies
adev deps update -p . --all
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

--all not sure if the -p and . are necessary flags / arguments

docs/usage.md Outdated
# Prepare release
git checkout main
git pull
adev release --dry-run # Check what would be released
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no dry run flag

persistent_schemas = [
schema for schema, details in schemas.items() if details.get("x-persistent")
]
persistent_schemas = [schema for schema, details in schemas.items() if details.get("x-persistent")]
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pretty sure this line is too long

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants