-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated the description and commands for locally running the docs
- Loading branch information
1 parent
9146e2a
commit 3ec1b6e
Showing
1 changed file
with
8 additions
and
33 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,13 @@ | ||
# Core DAO Documentation | ||
# Core DAO Developer Documentation | ||
|
||
This is the restructuring of Core DAO's official Docs built using [Docusaurus](https://docusaurus.io/). | ||
Welcome to the Core DAO Developer Documentation for Core Chain! This comprehensive guide is designed to assist developers in navigating and integrating with Core Chain effectively. Whether you are looking to build decentralized applications, participate in network governance, or simply explore the capabilities of Core Chain, this documentation provides all the necessary tools and resources. | ||
|
||
### Installation | ||
## Commands for Local Build | ||
|
||
``` | ||
$ npm run install | ||
* Install depencies `npm run install ` | ||
* Start the live-reloading docs server `npm run start` | ||
* Build the documentation site `npm run build` | ||
|
||
OR | ||
$ yarn | ||
``` | ||
|
||
### Local Development | ||
|
||
``` | ||
$ npm run start | ||
OR | ||
$ yarn start | ||
``` | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
### Build | ||
|
||
``` | ||
$ npm run build | ||
OR | ||
$ yarn build | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
## 📜 License | ||
|
||
Copyright (c) 2024 Core DAO |