https://github.com/archethic-foundation/archethic-docs
Official documentation of the Archethic Network
https://github.com/archethic-foundation/archethic-docs
archethic blockchain documentation
Last synced: 19 days ago
JSON representation
Official documentation of the Archethic Network
- Host: GitHub
- URL: https://github.com/archethic-foundation/archethic-docs
- Owner: archethic-foundation
- License: gfdl-1.3
- Created: 2021-09-08T08:52:37.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T12:38:48.000Z (about 2 months ago)
- Last Synced: 2025-04-10T13:54:55.698Z (about 2 months ago)
- Topics: archethic, blockchain, documentation
- Language: TypeScript
- Homepage: https://wiki.archethic.net
- Size: 495 MB
- Stars: 6
- Watchers: 6
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
# Archethic Documentation
Offical documentation for the Archethic network.
This documentation aims to provide the knowledge, the understanding and the actions to take in order
to contribute and make Archethic network more visible.
## Development
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```
npm install
```
### Local Development
```
npm 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
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### Update GraphQL documentation
To update the GraphQL schema documentation you can run the following command:
```
npx docusaurus graphql-to-doc
```
### Deployment
Github actions are setup to ease the deployment of the documentation.
Each time a commit is pushed to the main branch, a job is started to build the documentation and make the Github Page build up to date.