Merge pull request #202 from bitcoin-sv/fixDocDetails

Fix doc details
bitcoin-sv · Feb 12, 2025 · 2ff688e · 2ff688e
2 parents 2aca0ff + 61f35b1
commit 2ff688e
Show file tree

Hide file tree

Showing 12 changed files with 21 additions and 429 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -83,6 +83,14 @@ All notable changes to this project will be documented in this file. The format
 
 ---
 
+## [1.3.18] - 2025-02-12
+
+### Fixed
+
+- Avoid collapsing doc details. Not supported by github pages.
+
+---
+
 ## [1.3.17] - 2025-02-11
 
 ### Fixed

diff --git a/docs/auth.md b/docs/auth.md
@@ -129,10 +129,6 @@ export class AuthFetch {
 
 See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface)
 
-<details>
-
-<summary>Class AuthFetch Details</summary>
-
 #### Constructor
 
 Constructs a new AuthFetch instance.
@@ -194,8 +190,6 @@ async sendCertificateRequest(baseUrl: string, certificatesToRequest: RequestedCe
 ```
 See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [VerifiableCertificate](./auth.md#class-verifiablecertificate)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -228,10 +222,6 @@ export default class Certificate {
 
 See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletProtocol](./wallet.md#type-walletprotocol), [sign](./compat.md#variable-sign), [verify](./compat.md#variable-verify)
 
-<details>
-
-<summary>Class Certificate Details</summary>
-
 #### Constructor
 
 Constructs a new Certificate.
@@ -407,8 +397,6 @@ Returns
 
 - A promise that resolves to true if the signature is valid.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -483,10 +471,6 @@ export class MasterCertificate extends Certificate {
 
 See also: [Base64String](./wallet.md#type-base64string), [Certificate](./auth.md#class-certificate), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCounterparty](./wallet.md#type-walletcounterparty)
 
-<details>
-
-<summary>Class MasterCertificate Details</summary>
-
 #### Method createCertificateFields
 
 Encrypts certificate fields for a subject and generates a master keyring.
@@ -624,8 +608,6 @@ Throws
 
 Throws an error if any operation (e.g., encryption, signing) fails during certificate issuance.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -656,10 +638,6 @@ export class Peer {
 
 See also: [AuthMessage](./auth.md#interface-authmessage), [PeerSession](./auth.md#interface-peersession), [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [Transport](./auth.md#interface-transport), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface)
 
-<details>
-
-<summary>Class Peer Details</summary>
-
 #### Constructor
 
 Creates a new Peer instance
@@ -886,8 +864,6 @@ Throws
 
 Will throw an error if the message fails to send.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -909,10 +885,6 @@ export class SessionManager {
 
 See also: [PeerSession](./auth.md#interface-peersession)
 
-<details>
-
-<summary>Class SessionManager Details</summary>
-
 #### Method addSession
 
 Adds a session to the manager, associating it with relevant identifiers for retrieval.
@@ -990,8 +962,6 @@ Argument Details
 + **session**
   + The peer session to update.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1019,10 +989,6 @@ export class SimplifiedFetchTransport implements Transport {
 
 See also: [AuthMessage](./auth.md#interface-authmessage), [Transport](./auth.md#interface-transport)
 
-<details>
-
-<summary>Class SimplifiedFetchTransport Details</summary>
-
 #### Constructor
 
 Constructs a new instance of SimplifiedFetchTransport.
@@ -1106,8 +1072,6 @@ Throws
 
 Will throw an error if no listener has been registered via `onData`.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1134,10 +1098,6 @@ export class VerifiableCertificate extends Certificate {
 
 See also: [Base64String](./wallet.md#type-base64string), [Certificate](./auth.md#class-certificate), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex)
 
-<details>
-
-<summary>Class VerifiableCertificate Details</summary>
-
 #### Method decryptFields
 
 Decrypts selectively revealed certificate fields using the provided keyring and verifier wallet
@@ -1160,8 +1120,6 @@ Throws
 
 Throws an error if any of the decryption operations fail, with a message indicating the failure context.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1186,10 +1144,6 @@ export async function createNonce(wallet: WalletInterface, counterparty: WalletC
 
 See also: [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletInterface](./wallet.md#interface-walletinterface)
 
-<details>
-
-<summary>Function createNonce Details</summary>
-
 Returns
 
 A random nonce derived with a wallet
@@ -1199,8 +1153,6 @@ Argument Details
 + **counterparty**
   + The counterparty to the nonce creation. Defaults to 'self'.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1214,10 +1166,6 @@ export async function verifyNonce(nonce: string, wallet: WalletInterface, counte
 
 See also: [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletInterface](./wallet.md#interface-walletinterface)
 
-<details>
-
-<summary>Function verifyNonce Details</summary>
-
 Returns
 
 The status of the validation
@@ -1229,8 +1177,6 @@ Argument Details
 + **counterparty**
   + The counterparty to the nonce creation. Defaults to 'self'.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---

diff --git a/docs/compat.md b/docs/compat.md
@@ -34,10 +34,6 @@ export default class ECIES {
 
 See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
-<details>
-
-<summary>Class ECIES Details</summary>
-
 #### Method bitcoreDecrypt
 
 Decrypts a message encrypted using the Bitcore variant of ECIES.
@@ -153,8 +149,6 @@ Argument Details
 + **pubKey**
   + The receiver's public key.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -193,10 +187,6 @@ export default class HD {
 
 See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
-<details>
-
-<summary>Class HD Details</summary>
-
 #### Constructor
 
 Constructor for the BIP32 HD wallet.
@@ -455,8 +445,6 @@ Returns
 
 A base58 encoded string of the HD wallet.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -491,10 +479,6 @@ export default class Mnemonic {
 
 See also: [wordList](./compat.md#variable-wordlist)
 
-<details>
-
-<summary>Class Mnemonic Details</summary>
-
 #### Constructor
 
 Constructs a Mnemonic object.
@@ -794,8 +778,6 @@ Returns
 
 The mnemonic phrase as a string.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -825,19 +807,13 @@ export default function fromUtxo(utxo: jsonUtxo, unlockingScriptTemplate: {
 
 See also: [Transaction](./transaction.md#class-transaction), [TransactionInput](./transaction.md#interface-transactioninput), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
-<details>
-
-<summary>Function fromUtxo Details</summary>
-
 Argument Details
 
 + **utxo**
   + : jsonUtxo
 + **unlockingScriptTemplate**
   + : { sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>, estimateLength: (tx: Transaction, inputIndex: number) => Promise<number> }
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---