Skip to content

Commit ae02fe0

Browse files
committed
docs: Update README and docs with PyPI and documentation links
1 parent 43b28a4 commit ae02fe0

3 files changed

Lines changed: 16 additions & 5 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# pydantic-deep
22

3+
[![PyPI version](https://img.shields.io/pypi/v/pydantic-deep.svg)](https://pypi.org/project/pydantic-deep/)
34
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
45
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
56
[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://github.com/vstorm-co/pydantic-deep)
7+
[![CI](https://github.com/vstorm-co/pydantic-deep/actions/workflows/ci.yml/badge.svg)](https://github.com/vstorm-co/pydantic-deep/actions/workflows/ci.yml)
68

79
Deep agent framework built on [pydantic-ai](https://github.com/pydantic/pydantic-ai) with planning, filesystem, and subagent capabilities.
810

@@ -55,7 +57,16 @@ asyncio.run(main())
5557

5658
## Documentation
5759

58-
Full documentation is available at the [docs site](https://github.com/vstorm-co/pydantic-deep).
60+
- **[Full Documentation](https://vstorm-co.github.io/pydantic-deep/)** - Complete guides and API reference
61+
- **[PyPI Package](https://pypi.org/project/pydantic-deep/)** - Package information and releases
62+
- **[GitHub Repository](https://github.com/vstorm-co/pydantic-deep)** - Source code and issues
63+
64+
### Quick Links
65+
66+
- [Installation Guide](https://vstorm-co.github.io/pydantic-deep/installation/)
67+
- [Core Concepts](https://vstorm-co.github.io/pydantic-deep/concepts/)
68+
- [Examples](https://vstorm-co.github.io/pydantic-deep/examples/)
69+
- [API Reference](https://vstorm-co.github.io/pydantic-deep/api/)
5970

6071
## Development
6172

@@ -70,7 +81,7 @@ make install
7081
# Run tests
7182
make test
7283

73-
# Run all checks
84+
# Run all checks (lint, typecheck, test, coverage)
7485
make all
7586
```
7687

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
Deep Agent Framework, the Pydantic AI way
55
</p>
66

7-
[![CI](https://img.shields.io/badge/CI-passing-brightgreen)](https://github.com/vstorm-co/pydantic-deep)
7+
[![PyPI version](https://img.shields.io/pypi/v/pydantic-deep.svg)](https://pypi.org/project/pydantic-deep/)
8+
[![CI](https://github.com/vstorm-co/pydantic-deep/actions/workflows/ci.yml/badge.svg)](https://github.com/vstorm-co/pydantic-deep/actions/workflows/ci.yml)
89
[![coverage](https://img.shields.io/badge/coverage-100%25-brightgreen)](https://github.com/vstorm-co/pydantic-deep)
9-
[![pypi](https://img.shields.io/badge/pypi-v0.1.0-blue)](https://pypi.org/project/pydantic-deep/)
1010
[![python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org/)
1111
[![license](https://img.shields.io/badge/license-MIT-green)](https://opensource.org/licenses/MIT)
1212

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
site_name: pydantic-deep
22
site_description: Deep Agent Framework built on Pydantic AI
3-
site_url: https://github.com/vstorm-co/pydantic-deep
3+
site_url: https://vstorm-co.github.io/pydantic-deep/
44
repo_url: https://github.com/vstorm-co/pydantic-deep
55
repo_name: vstorm-co/pydantic-deep
66

0 commit comments

Comments
 (0)