Skip to content

Commit 2ecba34

Browse files
committed
update repository references in mkdocs configuration and add disclaimer to documentation
1 parent c1ca25f commit 2ecba34

7 files changed

Lines changed: 42 additions & 33 deletions

File tree

.github/workflows/cd-gitbook-sdk-docs.yaml

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

docs/mkdocs-python.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
site_name: HUMAN Protocol Python SDK Docs
22
site_url: https://sdk.humanprotocol.org/python/
3-
repo_name: humanprotocol/human-protocol-sdk
4-
repo_url: https://github.com/humanprotocol/human-protocol-sdk
3+
repo_name: humanprotocol/human-protocol
4+
repo_url: https://github.com/humanprotocol/human-protocol
55
docs_dir: ../packages/sdk/python/human-protocol-sdk/docs
66
site_dir: python
77
theme:

docs/mkdocs-ts.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
site_name: HUMAN Protocol TypeScript SDK Docs
22
site_url: https://sdk.humanprotocol.org/ts/
3-
repo_name: humanprotocol/human-protocol-sdk
4-
repo_url: https://github.com/humanprotocol/human-protocol-sdk
3+
repo_name: humanprotocol/human-protocol
4+
repo_url: https://github.com/humanprotocol/human-protocol
55
docs_dir: ../packages/sdk/typescript/human-protocol-sdk/docs
66
site_dir: ts
77
theme:

docs/overrides/assets/css/custom.css

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,3 +257,23 @@ h1, h2, h3, h4, h5, h6 {
257257
color: var(--md-primary-fg-color);
258258
font-weight: 700;
259259
}
260+
261+
/* Disclaimer bar */
262+
.md-disclaimer {
263+
background: rgb(212, 207, 255);
264+
color: var(--md-primary-fg-color);
265+
border-bottom: 1px solid rgba(99, 9, 255, 0.25);
266+
padding: 0.1rem 0;
267+
}
268+
269+
.md-disclaimer p {
270+
margin: 0;
271+
font-size: 0.6rem;
272+
text-align: center;
273+
}
274+
275+
.md-disclaimer__link {
276+
font-weight: 550;
277+
color: rgb(99, 9, 255);
278+
text-decoration: underline;
279+
}

docs/overrides/partials/header.html

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,15 @@
111111
{% endif %}
112112
</header>
113113

114+
<div class="md-disclaimer">
115+
<div class="md-grid">
116+
<p>
117+
The new styling applies starting with version 5.2.0. For earlier versions, visit
118+
<a href="https://legacy-sdk.humanprotocol.org" class="md-disclaimer__link">legacy-sdk.humanprotocol.org</a>.
119+
</p>
120+
</div>
121+
</div>
122+
114123
<script>
115124
(function () {
116125
function updateLangSwitch() {

packages/sdk/python/human-protocol-sdk/docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ HUMAN Protocol is a decentralized infrastructure for coordinating human work at
1414
- **Statistics**: Access protocol-wide metrics and analytics
1515
- **Encryption**: Secure message encryption using PGP for private communications
1616

17+
!!! info "Subgraph access and rate limits"
18+
The SDK calls public subgraph endpoints by default. Unauthenticated requests are rate-limited and may return errors. For higher limits, use your own [API key](https://thegraph.com/docs/it/subgraphs/querying/managing-api-keys/).
19+
1720
## Key Features
1821

1922
### Smart Contract Interactions

packages/sdk/typescript/human-protocol-sdk/docs/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ HUMAN Protocol is a decentralized infrastructure for coordinating human work at
1414
- **Statistics**: Access protocol-wide metrics and analytics
1515
- **Encryption**: Secure message encryption using PGP for private communications
1616

17+
!!! info "Subgraph access and rate limits"
18+
The SDK calls public subgraph endpoints by default. Unauthenticated requests are rate-limited and may return errors. For higher limits, use your own [API key](https://thegraph.com/docs/it/subgraphs/querying/managing-api-keys/).
19+
1720
## Key Features
1821

1922
### Smart Contract Clients
@@ -64,6 +67,9 @@ npm install @human-protocol/sdk
6467
yarn add @human-protocol/sdk
6568
```
6669

70+
!!! warning "Keep ethers in sync"
71+
The SDK is built against a specific `ethers` major/minor (currently `6.15.x`). Pin the same major/minor in your app. Mixing different minors (e.g., `6.16.x` with the SDK) can trigger errors.
72+
6773
## Quick Start
6874

6975
### Read-Only Operations

0 commit comments

Comments
 (0)