Skip to content

Commit b078067

Browse files
committed
docs: fix broken docs URLs and add API key comment to examples
Replace runcycles.github.io/docs and docs.runcycles.io with the correct runcycles.io domain. Add inline comment to CYCLES_API_KEY placeholder in examples/README.md. https://claude.ai/code/session_01HftF1nebzvUzQy4y4zGJk6
1 parent f615397 commit b078067

2 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@ def call_llm(prompt: str, tokens: int) -> str:
4646
result = call_llm("Hello", tokens=100)
4747
```
4848

49-
> **Need an API key?** API keys are created via the Cycles Admin Server (port 7979). See the [deployment guide](https://docs.runcycles.io/quickstart/deploying-the-full-cycles-stack#step-3-create-an-api-key) to create one, or run:
49+
> **Need an API key?** API keys are created via the Cycles Admin Server (port 7979). See the [deployment guide](https://runcycles.io/quickstart/deploying-the-full-cycles-stack#step-3-create-an-api-key) to create one, or run:
5050
> ```bash
5151
> curl -s -X POST http://localhost:7979/v1/admin/api-keys \
5252
> -H "Content-Type: application/json" \
5353
> -H "X-Admin-API-Key: admin-bootstrap-key" \
5454
> -d '{"tenant_id":"acme-corp","name":"dev-key","permissions":["reservations:create","reservations:commit","reservations:release","reservations:extend","reservations:list","balances:read","decide","events:create"]}' | jq -r '.key_secret'
5555
> ```
56-
> The key (e.g. `cyc_live_abc123...`) is shown only once — save it immediately. For key rotation and lifecycle details, see [API Key Management](https://docs.runcycles.io/how-to/api-key-management-in-cycles).
56+
> The key (e.g. `cyc_live_abc123...`) is shown only once — save it immediately. For key rotation and lifecycle details, see [API Key Management](https://runcycles.io/how-to/api-key-management-in-cycles).
5757
5858
### Programmatic client
5959
@@ -115,7 +115,7 @@ config = CyclesConfig.from_env()
115115
# Reads: CYCLES_BASE_URL, CYCLES_API_KEY, CYCLES_TENANT, etc.
116116
```
117117
118-
> **Need an API key?** See the [deployment guide](https://docs.runcycles.io/quickstart/deploying-the-full-cycles-stack#step-3-create-an-api-key) or [API Key Management](https://docs.runcycles.io/how-to/api-key-management-in-cycles).
118+
> **Need an API key?** See the [deployment guide](https://runcycles.io/quickstart/deploying-the-full-cycles-stack#step-3-create-an-api-key) or [API Key Management](https://runcycles.io/how-to/api-key-management-in-cycles).
119119
120120
### All options
121121

examples/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ Runnable examples demonstrating how to integrate the `runcycles` client into rea
44

55
## Prerequisites
66

7-
1. A running Cycles server (see [Deploy the Full Stack](https://runcycles.github.io/docs/quickstart/deploying-the-full-cycles-stack))
7+
1. A running Cycles server (see [Deploy the Full Stack](https://runcycles.io/quickstart/deploying-the-full-cycles-stack))
88
2. Set environment variables:
99

1010
```bash
1111
export CYCLES_BASE_URL="http://localhost:7878"
12-
export CYCLES_API_KEY="your-api-key"
12+
export CYCLES_API_KEY="your-api-key" # create via Admin Server — see link above
1313
export CYCLES_TENANT="acme"
1414
```
1515

0 commit comments

Comments
 (0)