Skip to content

Latest commit

 

History

History
54 lines (27 loc) · 1.67 KB

README.md

File metadata and controls

54 lines (27 loc) · 1.67 KB
Raw

Alaya Docs

The Alayas Docs is the central source of truth for Alaya.

You can view Alaya's conceptual documentation, Alaya technical specifications and developer tutorials.

Website: https://alaya.network/alaya-devdocs/en/

It is a community-focused initiative led by LatticeX Foundation to keep an up-to-date resource on the best information for learning, building, or maintaining on Alaya.

Working on this platform

To spin up a local instance of this new VuePress site, see below:

  1. Install the NPM dependencies:

    npm install

  2. Boot up the application in dev mode:

    npm run start     # English version
npm run start:zh  # 中文版本

  3. Preview the website at http://localhost:3000/ in your browser.

Contributing

The Docs is an open source project and we will review all issues and pull-requests created in this repository. If you notice typos or grammatical errors, please feel free to directly create pull requests with these corrections.

Larger contributions may start as issues to test the waters on the subject with the maintainers. It is generally preferable to create a pull request over an issue to propose a change to the wiki content.

Learn more about contributing to this docs site.

Current maintainers are: @biganxin @Vivi728

Contact

For help or support, you can ask for support at Discord or Forum.

License

The Alaya Docs is licensed under the MIT License free software license.