Skip to content

Commit f461f1f

Browse files
committed
docs: keep README cleanup without a supplemental guide
1 parent c3a9037 commit f461f1f

3 files changed

Lines changed: 3 additions & 101 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
### Changed
66

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

99
### Removed
1010

‎README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Forward also provides explicit administrator/Identity SAT issuance and revocatio
102102

103103
## Streaming
104104

105-
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.
105+
Streaming responses are consumed incrementally. Close the stream when finished and handle interruption explicitly; closing a local stream does not cancel server-side work.
106106

107107
## Asynchronous calls and cancellation
108108

@@ -133,7 +133,7 @@ for (com.qoder.cloudagents.forward.Template template : page) {
133133
}
134134
```
135135

136-
Use `page.data()` for only the current page, or `hasNextPage()` and `getNextPage()` / `getNextPageAsync()` for manual pagination. Filters, request options and server order are preserved. See the [usage guide](docs/usage-guide.md#pagination) for API-specific pagination behavior.
136+
Use `page.data()` for only the current page, or `hasNextPage()` and `getNextPage()` / `getNextPageAsync()` for manual pagination. Filters, request options and server order are preserved.
137137

138138
## Timeouts, retries and errors
139139

@@ -164,7 +164,6 @@ See [client configuration](docs/client-configuration.md) for detailed defaults a
164164

165165
## Documentation and examples
166166

167-
- [Usage guide](docs/usage-guide.md)
168167
- [Forward API reference](docs/forward-api-coverage.md)
169168
- [Managed API reference](docs/managed-api-coverage.md)
170169
- [Client configuration](docs/client-configuration.md)

‎docs/usage-guide.md‎

Lines changed: 0 additions & 97 deletions
This file was deleted.

0 commit comments

Comments
 (0)