XChainJS Typedoc Documentation Repository

Welcome to the XChainJS Typedoc Documentation Repository!

This repository hosts documentation for XChainJS, a library offering a unified interface across multiple blockchains. Xchain is a versatile and powerful blockchain library designed to simplify blockchain development across various platforms and programming languages.

This Xchain typedoc auto-generated documentation provides you with the right direction whether you're a beginner exploring blockchain technology or an experienced developer building decentralized applications (DApps), with an overview of the methods (functions), parameters, and structure of each package for better understanding.

Setup

Follow these steps to access the documentation locally:

Step 1: Clone the repository to your machine:

git clone https://github.com/kairosweb3/xchain-docs

Step 2: Navigate to the cloned directory:

cd xchain-docs

Accessing Documentation:

To render the documentation of all the packages on your browser follow these steps:

1. Click on the sidebar.html file and open it using a web browser (Chrome).
2. Click on your desired package from the sidebar of the webpage.
3. The package documentation will be rendered in your default web browser..

How to Generate Typedoc Documentation

Step 1: Clone the repository to your machine:

git clone https://github.com/xchainjs/xchainjs-lib.git

Step 2: Navigate to the cloned directory:

cd xchain-lib

Step 3: Open any of the packages directory in the terminal. For example, xchain-lib/xchain-wallet

Note: Make sure you have installed the typedoc npm package in your local machine globally. You can go through the typedoc documentation for more detail.

cd xchain-wallet
npm typedoc --out <path>

For example, npm typedoc npm typedoc --out src/wallet.ts src/index.ts

How the xchain-docs Repository Benefits Developers

1. Centralized Resource: Developers can access a centralized repository containing comprehensive documentation for the xchain-docs blockchain library. This makes it easy to find all relevant information in one place, streamlining the learning process.

2. Clear and Structured Content: The documentation is organized in a clear and structured manner, making it easy for developers to navigate and find the information they need. This includes a description, an overview of the methods, a description of parameters, and API references, ensuring the developers can quickly get up to speed with using the xchain-lib library.

3. Reference Material: Developers can refer to this repository to understand the functionalities and APIs provided by XChainJS, aiding in the development of wallets and other blockchain-related applications.

4. Troubleshooting and Support: Detailed documentation assists developers in troubleshooting issues and seeking support, thereby expediting the development lifecycle and improving overall user experience.

Contribution

We welcome contributions to enhance the documentation. If you spot errors or have suggestions for improvement, please don't hesitate to open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.