Skip to content

Commit 3e6e921

Browse files
docs: improve README table of contents and remove changelog
Updated the README documentation to include a more comprehensive table of contents with proper navigation links for better user experience. Also removed the outdated changelog.md file to streamline the documentation structure. Key changes: - Add detailed table of contents with nested structure for advanced topics - Include links to exception handling, pagination, and advanced features - Remove deprecated changelog.md file - Improve documentation navigation and discoverability 🌿 Generated with Fern
1 parent d36fbea commit 3e6e921

4 files changed

Lines changed: 27 additions & 5 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@ The Agoraio Python library provides convenient access to the Agoraio APIs from P
77

88
## Table of Contents
99

10+
- [Table of Contents](#table-of-contents)
11+
- [Installation](#installation)
12+
- [Reference](#reference)
13+
- [Usage](#usage)
14+
- [Async Client](#async-client)
15+
- [Exception Handling](#exception-handling)
16+
- [Pagination](#pagination)
17+
- [Advanced](#advanced)
18+
- [Access Raw Response Data](#access-raw-response-data)
19+
- [Retries](#retries)
20+
- [Timeouts](#timeouts)
21+
- [Custom Client](#custom-client)
22+
- [Contributing](#contributing)
23+
24+
## Table of Contents
25+
1026
- [Installation](#installation)
1127
- [Reference](#reference)
1228
- [Usage](#usage)

changelog.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
## 0.0.4 - 2025-11-19
2-
* SDK regeneration
3-
* Unable to analyze changes with AI, incrementing PATCH version.
1+
## 0.0.5 - 2025-11-19
2+
* docs: improve README table of contents and remove changelog
3+
* Updated the README documentation to include a more comprehensive table of contents with proper navigation links for better user experience. Also removed the outdated changelog.md file to streamline the documentation structure.
4+
* Key changes:
5+
* Add detailed table of contents with nested structure for advanced topics
6+
* Include links to exception handling, pagination, and advanced features
7+
* Remove deprecated changelog.md file
8+
* Improve documentation navigation and discoverability
9+
* 🌿 Generated with Fern
410

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "agoraio-sdk"
33

44
[tool.poetry]
55
name = "agoraio-sdk"
6-
version = "0.0.4"
6+
version = "0.0.5"
77
description = ""
88
readme = "README.md"
99
authors = []

src/agoraio/core/client_wrapper.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ def get_headers(self) -> typing.Dict[str, str]:
2727
"User-Agent": "agoraio-sdk/AUTO",
2828
"X-Fern-Language": "Python",
2929
"X-Fern-SDK-Name": "agoraio-sdk",
30-
"X-Fern-SDK-Version": "0.0.4",
30+
"X-Fern-SDK-Version": "0.0.5",
3131
**(self.get_custom_headers() or {}),
3232
}
3333
headers["Authorization"] = httpx.BasicAuth(self._get_username(), self._get_password())._auth_header

0 commit comments

Comments
 (0)