Skip to content

Commit f636b6f

Browse files
authored
Merge pull request #345 from anfredette/readme-links
docs: use absolute GitHub URLs in README for PyPI compatibility
2 parents 62db069 + 89858db commit f636b6f

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# <img src="docs/planner-logo.ico" alt="Planner" width="32" style="vertical-align: middle;"/> llm-d Planner
1+
# <img src="https://raw.githubusercontent.com/llm-d-incubation/llm-d-planner/main/docs/planner-logo.ico" alt="Planner" width="32" style="vertical-align: middle;"/> llm-d Planner
22

33
[![CI](https://github.com/llm-d-incubation/llm-d-planner/actions/workflows/ci.yml/badge.svg)](https://github.com/llm-d-incubation/llm-d-planner/actions/workflows/ci.yml)
44
[![Python
55
3.11+](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://www.python.org)
66
[![License: Apache
7-
2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
7+
2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/llm-d-incubation/llm-d-planner/blob/main/LICENSE)
88

99
**From business requirements to running llm-d deployments — sizing, estimation,
1010
and deployment in one workflow.**
@@ -32,15 +32,15 @@ spec = p.generate_specification(DeploymentIntent(
3232
recs = p.generate_recommendations(spec)
3333
```
3434

35-
See [Programmatic API User Guide](docs/PROGRAMMATIC_API_USER_GUIDE.md) for complete documentation.
35+
See [Programmatic API User Guide](https://github.com/llm-d-incubation/llm-d-planner/blob/main/docs/PROGRAMMATIC_API_USER_GUIDE.md) for complete documentation.
3636

3737
### As a Standalone Application
3838

3939
```bash
4040
make setup && make start
4141
```
4242

43-
See [Developer Guide](docs/DEVELOPER_GUIDE.md) for setup instructions.
43+
See [Developer Guide](https://github.com/llm-d-incubation/llm-d-planner/blob/main/docs/DEVELOPER_GUIDE.md) for setup instructions.
4444

4545
---
4646

@@ -214,7 +214,7 @@ types, ranked by cost.
214214

215215
## Architecture
216216

217-
See [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for detailed system design.
217+
See [docs/ARCHITECTURE.md](https://github.com/llm-d-incubation/llm-d-planner/blob/main/docs/ARCHITECTURE.md) for detailed system design.
218218

219219
## Implemented Features
220220

@@ -342,19 +342,19 @@ tab in the UI, or via the REST API:
342342
- `PUT /api/v1/deployment-mode` - Set mode (`{"mode": "simulator"}` or `{"mode":
343343
"production"}`)
344344

345-
See [docs/DEVELOPER_GUIDE.md](docs/DEVELOPER_GUIDE.md#vllm-simulator-details)
345+
See [docs/DEVELOPER_GUIDE.md](https://github.com/llm-d-incubation/llm-d-planner/blob/main/docs/DEVELOPER_GUIDE.md#vllm-simulator-details)
346346
for details.
347347

348348
## Documentation
349349

350-
- **[Developer Guide](docs/DEVELOPER_GUIDE.md)** - Development workflows,
350+
- **[Developer Guide](https://github.com/llm-d-incubation/llm-d-planner/blob/main/docs/DEVELOPER_GUIDE.md)** - Development workflows,
351351
testing, debugging
352-
- **[Architecture](docs/ARCHITECTURE.md)** - Detailed system design and
352+
- **[Architecture](https://github.com/llm-d-incubation/llm-d-planner/blob/main/docs/ARCHITECTURE.md)** - Detailed system design and
353353
component specifications
354-
- **[Traffic and SLOs](docs/traffic_and_slos.md)** - Traffic profile framework
354+
- **[Traffic and SLOs](https://github.com/llm-d-incubation/llm-d-planner/blob/main/docs/traffic_and_slos.md)** - Traffic profile framework
355355
and experience-driven SLOs (Phase 2)
356-
- **[Logging Guide](docs/LOGGING.md)** - Logging system and debugging
357-
- **[Claude Code Guidance](CLAUDE.md)** - AI assistant instructions for
356+
- **[Logging Guide](https://github.com/llm-d-incubation/llm-d-planner/blob/main/docs/LOGGING.md)** - Logging system and debugging
357+
- **[Claude Code Guidance](https://github.com/llm-d-incubation/llm-d-planner/blob/main/CLAUDE.md)** - AI assistant instructions for
358358
contributors
359359

360360
## Future Enhancements
@@ -371,12 +371,12 @@ Some of these enhancements may involve collaboration with other llm-d SIGs.
371371

372372
## Contributing
373373

374-
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for
374+
Contributions are welcome! See [CONTRIBUTING.md](https://github.com/llm-d-incubation/llm-d-planner/blob/main/CONTRIBUTING.md) for
375375
guidelines.
376376

377-
See [CLAUDE.md](CLAUDE.md) for AI assistant guidance when making changes.
377+
See [CLAUDE.md](https://github.com/llm-d-incubation/llm-d-planner/blob/main/CLAUDE.md) for AI assistant guidance when making changes.
378378

379379
## License
380380

381381
This project is licensed under Apache License 2.0. See the [LICENSE
382-
file](LICENSE) for details.
382+
file](https://github.com/llm-d-incubation/llm-d-planner/blob/main/LICENSE) for details.

0 commit comments

Comments
 (0)