Draft
Conversation
- Changed label from "Apis" to "APIs" in _category_.json. - Added new categories for Core APIs, Governance, Providers, Standards & CIPs, Transaction Building, and Utility APIs. - Removed deprecated address-api.md, cip68-api.md, and governance-api.md files to streamline documentation.
#521) * docs: add comprehensive API documentation for Account, Address, HD Wallet, Metadata, and Plutus APIs - Introduced new documentation files for Account API, Address API, HD Wallet API, Metadata API, and Plutus API. - Each API documentation includes key features, usage examples, and core classes to enhance developer understanding and usability. - Structured the documentation to support both CBOR and JSON formats for metadata and provided detailed examples for transaction interactions. * docs: enhance Account API documentation with constructor details and mnemonic validation updates - Added constructors for creating accounts with generated or existing mnemonics. - Updated mnemonic validation example to utilize MnemonicUtil for improved clarity. - Removed outdated comparison section with HD Wallet API to streamline content. * docs: update Address API documentation to remove network detection feature - Removed the network detection section from the Address API documentation to streamline content. - Enhanced clarity by reorganizing key methods and their descriptions. * docs: update HD Wallet API documentation to clarify backup and use case details - Removed the backup simplicity feature to streamline the documentation. - Updated the use case section to specify when to use the Account API for single address applications. * docs: streamline Metadata API documentation by removing common metadata labels section - Removed the detailed table of common metadata labels to simplify the content. - Updated the description to emphasize support for standard metadata formats while allowing custom structures. * docs: refine Plutus API documentation by removing outdated sections - Removed sections on blueprint loading and object to PlutusData conversion to streamline content. - Updated key features to focus on essential functionalities, enhancing clarity and usability for developers.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
implementation of #518