Skip to content

Commit fe65294

Browse files
Update claude instruction and clarify AI usage in the development
1 parent fad1421 commit fe65294

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

CLAUDE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,18 @@ uv run ruff check
2525
uv run ruff format
2626
```
2727

28+
**Type checking**
29+
```bash
30+
uv run pyright
31+
```
32+
2833
**Documentation:**
2934
```bash
3035
# Serve docs locally with auto-reload
3136
uv run mkdocs serve
3237

3338
# Build documentation
3439
uv run mkdocs build
35-
36-
# Export documentation dependencies for Read The Docs
37-
uv export --no-hashes --format requirements-txt --group documentation > docs/requirements.txt
3840
```
3941

4042
## Architecture Overview

docs/faq.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,13 @@ This library is designed for embedding into applications and can be used in prod
1616

1717
## What is the license?
1818

19-
This project is licensed under the Apache 2.0 License. See the license for details: https://www.apache.org/licenses/LICENSE-2.0
19+
This project is licensed under the Apache 2.0 License. See the license for details: https://www.apache.org/licenses/LICENSE-2.0
20+
21+
22+
## How AI was used to develop this project?
23+
24+
Claude code have been used for:
25+
* Challenge the API naming
26+
* Help improve documentation
27+
* Help improve test quality
28+
* Generate example usage

0 commit comments

Comments
 (0)