Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/remove docusaurus versioning #1276

Merged
merged 5 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 0 additions & 20 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,6 @@ $ yarn build

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Versioning

We leverage Docusaurus's built-in support for versioning.
For more details, see the [documentation](https://docusaurus.io/docs/versioning).

NOTE: Please keep the version number consistent with our SDK version numbers.

To create a new version:

```
yarn docusaurus docs:version VERSION_NUMBER

```

For your convenience, this script will create a new version based on `../sdk/package.json`

```
yarn version:new
```

### Deployment

Using SSH:
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developer/api/sdk/classes/ClientError.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Error.constructor

#### Defined in

[sdk/src/types/errors.ts:27](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/types/errors.ts#L27)
[sdk/src/types/errors.ts:27](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/types/errors.ts#L27)

## Properties

Expand Down Expand Up @@ -105,7 +105,7 @@ Additional error payload.

#### Defined in

[sdk/src/types/errors.ts:20](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/types/errors.ts#L20)
[sdk/src/types/errors.ts:20](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/types/errors.ts#L20)

---

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developer/api/sdk/classes/ConfigurationError.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Error.constructor

#### Defined in

[sdk/src/types/errors.ts:188](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/types/errors.ts#L188)
[sdk/src/types/errors.ts:188](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/types/errors.ts#L188)

## Properties

Expand Down Expand Up @@ -103,7 +103,7 @@ Additional error payload.

#### Defined in

[sdk/src/types/errors.ts:187](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/types/errors.ts#L187)
[sdk/src/types/errors.ts:187](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/types/errors.ts#L187)

---

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developer/api/sdk/classes/ContractError.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Error.constructor

#### Defined in

[sdk/src/types/errors.ts:43](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/types/errors.ts#L43)
[sdk/src/types/errors.ts:43](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/types/errors.ts#L43)

## Properties

Expand Down Expand Up @@ -104,7 +104,7 @@ Additional error payload.

#### Defined in

[sdk/src/types/errors.ts:41](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/types/errors.ts#L41)
[sdk/src/types/errors.ts:41](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/types/errors.ts#L41)

---

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developer/api/sdk/classes/FetchError.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Error.constructor

#### Defined in

[sdk/src/types/errors.ts:65](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/types/errors.ts#L65)
[sdk/src/types/errors.ts:65](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/types/errors.ts#L65)

## Properties

Expand Down Expand Up @@ -105,7 +105,7 @@ Additional error payload.

#### Defined in

[sdk/src/types/errors.ts:58](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/types/errors.ts#L58)
[sdk/src/types/errors.ts:58](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/types/errors.ts#L58)

---

Expand Down
58 changes: 29 additions & 29 deletions docs/docs/developer/api/sdk/classes/HypercertClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Will throw a `ClientError` if the public client cannot be connected.

#### Defined in

[sdk/src/client.ts:58](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L58)
[sdk/src/client.ts:58](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L58)

## Properties

Expand All @@ -64,7 +64,7 @@ Will throw a `ClientError` if the public client cannot be connected.

#### Defined in

[sdk/src/client.ts:41](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L41)
[sdk/src/client.ts:41](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L41)

---

Expand All @@ -74,7 +74,7 @@ Will throw a `ClientError` if the public client cannot be connected.

#### Defined in

[sdk/src/client.ts:44](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L44)
[sdk/src/client.ts:44](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L44)

---

Expand All @@ -84,7 +84,7 @@ Will throw a `ClientError` if the public client cannot be connected.

#### Defined in

[sdk/src/client.ts:45](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L45)
[sdk/src/client.ts:45](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L45)

---

Expand Down Expand Up @@ -158,7 +158,7 @@ Will throw a `ClientError` if the public client cannot be connected.

#### Defined in

[sdk/src/client.ts:46](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L46)
[sdk/src/client.ts:46](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L46)

---

Expand All @@ -168,7 +168,7 @@ Will throw a `ClientError` if the public client cannot be connected.

#### Defined in

[sdk/src/client.ts:42](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L42)
[sdk/src/client.ts:42](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L42)

---

Expand Down Expand Up @@ -212,7 +212,7 @@ Will throw a `ClientError` if the public client cannot be connected.

#### Defined in

[sdk/src/client.ts:47](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L47)
[sdk/src/client.ts:47](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L47)

---

Expand All @@ -228,7 +228,7 @@ Whether the client is in read-only mode.

#### Defined in

[sdk/src/client.ts:48](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L48)
[sdk/src/client.ts:48](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L48)

## Accessors

Expand All @@ -246,7 +246,7 @@ The client config.

#### Defined in

[sdk/src/client.ts:82](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L82)
[sdk/src/client.ts:82](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L82)

---

Expand All @@ -272,7 +272,7 @@ Use getDeployments instead.

#### Defined in

[sdk/src/client.ts:107](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L107)
[sdk/src/client.ts:107](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L107)

---

Expand All @@ -294,7 +294,7 @@ The indexer.

#### Defined in

[sdk/src/client.ts:98](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L98)
[sdk/src/client.ts:98](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L98)

---

Expand All @@ -316,7 +316,7 @@ The storage layer.

#### Defined in

[sdk/src/client.ts:90](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L90)
[sdk/src/client.ts:90](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L90)

## Methods

Expand Down Expand Up @@ -355,7 +355,7 @@ Will throw an `InvalidOrMissingError` if any of the proofs are invalid.

#### Defined in

[sdk/src/client.ts:454](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L454)
[sdk/src/client.ts:456](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L456)

---

Expand Down Expand Up @@ -388,7 +388,7 @@ A promise that resolves to the transaction hash.

#### Defined in

[sdk/src/client.ts:216](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L216)
[sdk/src/client.ts:216](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L216)

---

Expand Down Expand Up @@ -425,7 +425,7 @@ Will throw a `ClientError` if the claim is not owned by the account.

#### Defined in

[sdk/src/client.ts:377](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L377)
[sdk/src/client.ts:379](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L379)

---

Expand Down Expand Up @@ -466,7 +466,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval

#### Defined in

[sdk/src/client.ts:249](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L249)
[sdk/src/client.ts:249](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L249)

---

Expand All @@ -486,7 +486,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval

#### Defined in

[sdk/src/client.ts:485](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L485)
[sdk/src/client.ts:487](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L487)

---

Expand All @@ -506,7 +506,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval

#### Defined in

[sdk/src/client.ts:502](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L502)
[sdk/src/client.ts:504](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L504)

---

Expand All @@ -520,7 +520,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval

#### Defined in

[sdk/src/client.ts:491](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L491)
[sdk/src/client.ts:493](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L493)

---

Expand Down Expand Up @@ -552,7 +552,7 @@ Use getDeployments instead.

#### Defined in

[sdk/src/client.ts:120](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L120)
[sdk/src/client.ts:120](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L120)

---

Expand Down Expand Up @@ -582,7 +582,7 @@ a Promise that resolves to the applicable transfer restrictions.

#### Defined in

[sdk/src/client.ts:168](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L168)
[sdk/src/client.ts:168](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L168)

---

Expand Down Expand Up @@ -630,7 +630,7 @@ a Promise that resolves to the applicable transfer restrictions.

#### Defined in

[sdk/src/client.ts:512](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L512)
[sdk/src/client.ts:514](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L514)

---

Expand Down Expand Up @@ -667,7 +667,7 @@ Will throw a `ClientError` if any of the fractions are not owned by the account.

#### Defined in

[sdk/src/client.ts:336](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L336)
[sdk/src/client.ts:338](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L338)

---

Expand Down Expand Up @@ -707,7 +707,7 @@ Will throw a `MalformedDataError` if the provided metadata is invalid.

#### Defined in

[sdk/src/client.ts:139](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L139)
[sdk/src/client.ts:139](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L139)

---

Expand Down Expand Up @@ -746,7 +746,7 @@ Will throw an `InvalidOrMissingError` if the proof is invalid.

#### Defined in

[sdk/src/client.ts:410](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L410)
[sdk/src/client.ts:412](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L412)

---

Expand All @@ -769,7 +769,7 @@ Will throw an `InvalidOrMissingError` if the proof is invalid.

#### Defined in

[sdk/src/client.ts:522](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L522)
[sdk/src/client.ts:524](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L524)

---

Expand Down Expand Up @@ -808,7 +808,7 @@ Will throw a `ClientError` if the fraction is not owned by the account or if the

#### Defined in

[sdk/src/client.ts:291](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L291)
[sdk/src/client.ts:293](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L293)

---

Expand Down Expand Up @@ -838,7 +838,7 @@ Will throw a `ClientError` if the request fails.

#### Defined in

[sdk/src/client.ts:553](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L553)
[sdk/src/client.ts:555](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L555)

---

Expand Down Expand Up @@ -871,4 +871,4 @@ A promise that resolves to the transaction hash.

#### Defined in

[sdk/src/client.ts:188](https://github.com/hypercerts-org/hypercerts/blob/e194fdd/sdk/src/client.ts#L188)
[sdk/src/client.ts:188](https://github.com/hypercerts-org/hypercerts/blob/efdb2e8/sdk/src/client.ts#L188)
Loading
Loading