Skip to content
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
10 changes: 4 additions & 6 deletions docs/1-onboarding/README.md → docs/onboarding/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,7 @@ docs/
│ ├── 04-robot-framework-better-but-limited.md
│ ├── 05-why-agentic-ai-for-automation.md
│ └── 06-project-glossary.md
├── 2-setup/ # Installation and configuration guides
├── architecture/ # System design and technical decisions
└── api/ # Keyword reference and usage examples
└── 2-dev-setup/ # Installation and configuration guides
```

## Contributing to Docs
Expand All @@ -68,9 +66,9 @@ Keep docs:
## Next Steps

After completing the onboarding:
1. Check the `2-setup/` folder for installation and configuration guides
2. Explore the codebase and architecture docs
1. Check the `2-dev-setup/` folder for installation and configuration guides
2. Explore the codebase
3. Start contributing or experimenting with the agent

Welcome aboard! 🚀
Welcome aboard!

Original file line number Diff line number Diff line change
Expand Up @@ -20,41 +20,17 @@ cd <REPO_NAME>
python -m venv .venv
source .venv/bin/activate # Windows: .venv\Scripts\activate

pip install -r requirements.txt
pip install -e ".[dev]"
```

## Configure environment

Create a local env file or RF variable file (example name):

- `config/local.yaml`
- or `variables.py`
- or `variables.robot`

Set at least:

- LLM provider + key
- target platform (web / android / ios)
- device/browser settings
- artifact output path

Example (pseudo):

```yaml
llm:
provider: openai
model: gpt-4.1-mini
api_key: "<YOUR_KEY>"

runtime:
platform: android
artifacts_dir: "./artifacts"
```
Copy `env.example` to `.env` and set your keys/config.

## Run a sample suite

```bash
robot -L TRACE tests/agent_smoke.robot
pytest tests/utest -q
```

## Outputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,6 @@ appium-doctor --ios

Once Appium is running:
1. Configure your `.env` file with device capabilities
2. Run the quickstart guide: [07-dev-setup-quickstart.md](07-dev-setup-quickstart.md)
2. Run the quickstart guide: [01-dev-setup-quickstart.md](01-dev-setup-quickstart.md)
3. Start writing tests with the Agent library

Loading