-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Summary
The repository README.md needs an update to reflect the current codebase, installation, and usage patterns. Several files and scripts (for example run.sh, Dockerfile, the tools/ directory, and the src/ structure) have changed since the README was written. This task is to audit and enhance the README so new contributors and users can get started quickly.
Scope
- Update installation and environment setup instructions (Python/venv, required packages, Docker steps if applicable).
- Update how to run tests and local development (e.g.,
run.sh, any make/npm/powershell instructions). - Refresh usage examples and command-line examples for core tools (brief examples for
tools/functions like browser tools). - Ensure file tree and important directories (
src/,tools/,robot_tests/,docs/) are described. - Add or update troubleshooting notes and links to detailed docs in
docs/. - Add a short "Quick start" section with copy-paste commands for Windows (PowerShell) and Linux/macOS.
Tasks
- Audit current
README.mdanddocs/for outdated sections. - Update installation and environment instructions.
- Update run/dev/test instructions and examples.
- Add a Quick Start snippet for Windows PowerShell and for Unix shells.
- Verify Dockerfile/run.sh instructions and update or link to
DOCKER_BUILD_GUIDE.md. - Add links to
docs/where deeper info exists and ensure consistency. - Proofread for clarity and remove dead/copy-paste instructions.
Acceptance criteria
- README accurately reflects how to get the project running locally (at least one verified set of commands for Windows PowerShell and one for Unix-like shells).
- Key repo directories are documented with short descriptions.
- The issue includes a checklist to track progress.
Notes
- Assigning to @Devasy23 as requested.
- If you need, please open follow-up issues for larger docs rewrites or a separate PR template for docs.
Please update the issue or comment when done and include the PR link that made the README changes.
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request