XDeFi-tech / docs-new

Developers Documentation to BUIDL on XDEFI

Home Page:https://developers.xdefi.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

XDEFI Technologies Documentation Site

Welcome to the official documentation repository for Ctrl (fka XDEFI) Technologies.

Here you'll find comprehensive guides, tutorials, and reference materials to help you make easy integration and usage of our products (Wallets (extension and mobile), routing aggregator API).

Building the site

To get started, clone the repository and run the following:

yarn && yarn dev

This documentation site is built with VitePress

Contribution Guidelines

We love contributions from the community! Whether you're fixing typos, improving content clarity, or adding new topics, every contribution helps.

  • Fork & Clone: Fork this repository and clone it to your local machine.
  • Branch: Always create a new branch for your changes. Naming it relevantly.
  • Commit Changes: Make your changes and commit them with a clear and concise commit message.
  • Push & Create PR: Push your changes to your fork and create a pull request to the main branch of this repository.

Please ensure to review the detailed Contribution Guidelines before making a pull request.

Directory Structure

  • /.vitepress: Configuration files for the VitePress site.
  • /public: Static assets like images, diagrams, and other media files.
  • /assets: Images, diagrams, and other media files used in the documentation.
  • /components: Custom React components integrated into the documentation.
  • /about: A category for learning more about Ctrl (fka XDEFI) Technologies and $XDEFI token.
  • /campaigns: A category for Campaigns Service API
  • /developers: A category with tutorials and guides for deploying
  • /routing: Technical reference materials for integrating our Routing aggregator API.
  • /assets-service: A category for Assets Service API dApps and connect with Ctrl Wallet.
  • /indexers: A category for Indexers API
  • /gas-tank: A category for Gas Tank API
  • /staking: A category for Staking API

Feedback & Suggestions

We value feedback from the community. If you have suggestions for improvements or find any discrepancies in the documentation, please raise an issue in this repository.

About

Developers Documentation to BUIDL on XDEFI

https://developers.xdefi.io


Languages

Language:JavaScript 82.1%Language:TypeScript 16.3%Language:CSS 1.5%Language:Shell 0.1%