Skip to content

Commit 27c37f9

Browse files
committed
docs: keep README cleanup without a supplemental guide
1 parent 37faa88 commit 27c37f9

4 files changed

Lines changed: 10 additions & 680 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ existing `0.1.0` release; earlier development prereleases are not listed.
77

88
### Changed
99

10-
- Move resource-specific README documentation into a dedicated usage guide, keeping the README focused on SDK setup and shared client behavior.
10+
- Remove resource-specific sections and inventories from the README to keep it focused on SDK setup and shared client behavior.
1111

1212
## [0.14.0]
1313

‎README.md‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Every method shown in this document has an async counterpart with the same name
159159

160160
## Streaming
161161

162-
Streaming responses are consumed incrementally. Close the stream when finished and handle interruption explicitly; closing a local stream does not cancel server-side work. See the [usage guide](docs/usage-guide.md) for runnable patterns and reconnection behavior.
162+
Streaming responses are consumed incrementally. Close the stream when finished and handle interruption explicitly; closing a local stream does not cancel server-side work.
163163

164164
## Handling errors
165165

@@ -350,7 +350,6 @@ print(qca.__version__)
350350

351351
## Documentation and examples
352352

353-
- [Usage guide](docs/usage-guide.md)
354353
- [API reference](docs/api/reference.md)
355354
- [Runnable examples](examples/)
356355
- [Contribution guide](CONTRIBUTING.md)

0 commit comments

Comments
 (0)