From 68dae6063fcfaa203c3406fbee20c084358252d0 Mon Sep 17 00:00:00 2001 From: hassineabd Date: Fri, 19 Dec 2025 00:27:17 +0100 Subject: [PATCH] update docs --- .../00-why-this-project.md | 0 .../01-testing-qa-basics.md | 0 .../02-automation-tools-explained.md | 0 .../03-traditional-automation-with-code.md | 0 .../04-robot-framework-better-but-limited.md | 0 .../05-why-agentic-ai-for-automation.md | 0 .../06-project-glossary.md | 0 docs/{1-onboarding => onboarding}/README.md | 10 +++---- .../01-dev-setup-quickstart.md | 30 ++----------------- .../02-appium-installation.md | 2 +- 10 files changed, 8 insertions(+), 34 deletions(-) rename docs/{1-onboarding => onboarding}/00-why-this-project.md (100%) rename docs/{1-onboarding => onboarding}/01-testing-qa-basics.md (100%) rename docs/{1-onboarding => onboarding}/02-automation-tools-explained.md (100%) rename docs/{1-onboarding => onboarding}/03-traditional-automation-with-code.md (100%) rename docs/{1-onboarding => onboarding}/04-robot-framework-better-but-limited.md (100%) rename docs/{1-onboarding => onboarding}/05-why-agentic-ai-for-automation.md (100%) rename docs/{1-onboarding => onboarding}/06-project-glossary.md (100%) rename docs/{1-onboarding => onboarding}/README.md (87%) rename docs/{2-dev-setup => setup-dev}/01-dev-setup-quickstart.md (63%) rename docs/{2-dev-setup => setup-dev}/02-appium-installation.md (98%) diff --git a/docs/1-onboarding/00-why-this-project.md b/docs/onboarding/00-why-this-project.md similarity index 100% rename from docs/1-onboarding/00-why-this-project.md rename to docs/onboarding/00-why-this-project.md diff --git a/docs/1-onboarding/01-testing-qa-basics.md b/docs/onboarding/01-testing-qa-basics.md similarity index 100% rename from docs/1-onboarding/01-testing-qa-basics.md rename to docs/onboarding/01-testing-qa-basics.md diff --git a/docs/1-onboarding/02-automation-tools-explained.md b/docs/onboarding/02-automation-tools-explained.md similarity index 100% rename from docs/1-onboarding/02-automation-tools-explained.md rename to docs/onboarding/02-automation-tools-explained.md diff --git a/docs/1-onboarding/03-traditional-automation-with-code.md b/docs/onboarding/03-traditional-automation-with-code.md similarity index 100% rename from docs/1-onboarding/03-traditional-automation-with-code.md rename to docs/onboarding/03-traditional-automation-with-code.md diff --git a/docs/1-onboarding/04-robot-framework-better-but-limited.md b/docs/onboarding/04-robot-framework-better-but-limited.md similarity index 100% rename from docs/1-onboarding/04-robot-framework-better-but-limited.md rename to docs/onboarding/04-robot-framework-better-but-limited.md diff --git a/docs/1-onboarding/05-why-agentic-ai-for-automation.md b/docs/onboarding/05-why-agentic-ai-for-automation.md similarity index 100% rename from docs/1-onboarding/05-why-agentic-ai-for-automation.md rename to docs/onboarding/05-why-agentic-ai-for-automation.md diff --git a/docs/1-onboarding/06-project-glossary.md b/docs/onboarding/06-project-glossary.md similarity index 100% rename from docs/1-onboarding/06-project-glossary.md rename to docs/onboarding/06-project-glossary.md diff --git a/docs/1-onboarding/README.md b/docs/onboarding/README.md similarity index 87% rename from docs/1-onboarding/README.md rename to docs/onboarding/README.md index b2ed73d..0bc7f48 100644 --- a/docs/1-onboarding/README.md +++ b/docs/onboarding/README.md @@ -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 @@ -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! diff --git a/docs/2-dev-setup/01-dev-setup-quickstart.md b/docs/setup-dev/01-dev-setup-quickstart.md similarity index 63% rename from docs/2-dev-setup/01-dev-setup-quickstart.md rename to docs/setup-dev/01-dev-setup-quickstart.md index ac13af8..59de012 100644 --- a/docs/2-dev-setup/01-dev-setup-quickstart.md +++ b/docs/setup-dev/01-dev-setup-quickstart.md @@ -20,41 +20,17 @@ cd 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: "" - -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 diff --git a/docs/2-dev-setup/02-appium-installation.md b/docs/setup-dev/02-appium-installation.md similarity index 98% rename from docs/2-dev-setup/02-appium-installation.md rename to docs/setup-dev/02-appium-installation.md index ea87842..1217755 100644 --- a/docs/2-dev-setup/02-appium-installation.md +++ b/docs/setup-dev/02-appium-installation.md @@ -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