Skip to content

DEVP-10: Fix broken documentation links in README #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oalami merged 2 commits into from
Nov 6, 2025
Merged

DEVP-10: Fix broken documentation links in README #38

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af9dafa
Update Readme.md to hyperlink to Github to resolve broken links on Py…
cmworkato Nov 5, 2025
a89154b
Correct typo in hyperlinks in Readme.md
cmworkato Nov 6, 2025
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
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Get the Workato CLI running in 5 minutes.
- Workato account with API token

### Getting Your API Token

1. Log into your Workato account
1. Navigate to **Workspace Admin** → **API clients**
1. Click **Create API client**
Expand All @@ -34,18 +35,20 @@ Get the Workato CLI running in 5 minutes.
## Installation

### From PyPI (Coming Soon)

```bash
pip install workato-platform-cli
```

### From Source

```bash
git clone https://github.com/workato-devs/workato-platform-cli.git
cd workato-platform-cli
make install
```

Having issues? See [DEVELOPER_GUIDE.md](/docs/DEVELOPER_GUIDE.md) for troubleshooting.
Having issues? See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/DEVELOPER_GUIDE.md) for troubleshooting.

## Setup

Expand All @@ -57,7 +60,6 @@ workato init
workato workspace
```


## First Commands

```bash
Expand All @@ -76,12 +78,11 @@ workato workspace

## Next Steps

- **Need detailed commands?** → See [COMMAND_REFERENCE.md](/docs/COMMAND_REFERENCE.md)
- **Want real-world examples?** → See [USE_CASES.md](/docs/USE_CASES.md)
- **Looking for sample recipes?** → See [examples/](/docs/examples/)
- **Installation issues?** → See [DEVELOPER_GUIDE.md](/docs/DEVELOPER_GUIDE.md)
- **Looking for all documentation?** → See [INDEX.md](/docs/INDEX.md)

- **Need detailed commands?** → See [COMMAND_REFERENCE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/COMMAND_REFERENCE.md)
- **Want real-world examples?** → See [USE_CASES.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/USE_CASES.md)
- **Looking for sample recipes?** → See [examples/](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/examples/)
- **Installation issues?** → See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/DEVELOPER_GUIDE.md)
- **Looking for all documentation?** → See [INDEX.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/INDEX.md)

## Quick Recipe Workflow

Expand All @@ -98,12 +99,12 @@ workato pull

You're ready to go!


## Contributing to the CLI

These commands are for CLI maintainers and contributors, not for developers using the CLI to build Workato integrations.

### For Development

```bash
# Setup (with uv - recommended)
make install-dev
Expand All @@ -119,8 +120,8 @@ make lint # check code quality
make build # build distribution packages
```


### Tech Stack

- **🐍 Python 3.11+** with full type annotations
- **⚡ uv** for fast dependency management
- **🔍 mypy** for static type checking
Expand Down