https://github.com/chainsafe/engineering-handbook
ChainSafe Engineering Handbook
https://github.com/chainsafe/engineering-handbook
chainsafe engineering handbook
Last synced: 3 months ago
JSON representation
ChainSafe Engineering Handbook
- Host: GitHub
- URL: https://github.com/chainsafe/engineering-handbook
- Owner: ChainSafe
- License: apache-2.0
- Created: 2020-11-13T13:39:34.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-03T18:44:45.000Z (7 months ago)
- Last Synced: 2025-10-02T02:53:25.847Z (4 months ago)
- Topics: chainsafe, engineering, handbook
- Language: TypeScript
- Homepage: https://handbook.chainsafe.io
- Size: 4.55 MB
- Stars: 6
- Watchers: 25
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# ChainSafe Engineering Handbook
This handbook is a guide for all engineers at ChainSafe. It contains content relating to organizational structure and processes, as well as technical guidelines and best practices.
The handbook is built using [Docusaurus 2](https://docusaurus.io/), a modern static docs generator.
# Dependencies
This project requires `yarn`. You can find installation instructions [here](https://yarnpkg.com/getting-started/install).
# Running Locally
Fetch project dependencies:
```
$ yarn
```
Start development server:
```
$ yarn start
```
This command starts a local development server (localhost:3000) and opens up a browser window. Most changes are reflected live without having to restart the server.
# Spellcheck
```
yarn spellcheck
```
You can add unknown words to `dictionary.txt`.
# Building
```
$ yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
# Contributing
All contributions are welcomed! This is intended to be a living document and requires contributions of many to be maintained.
Please use GitHub Issues to propose any large changes and to facilitate discussion and questions regarding content and structure.
It is recommended you review the [Docusaurus docs](https://docusaurus.io/docs) to ensure you utilize its features correctly.
# Project Structure
`docs/` -- The handbook content lives here, separated by sections
`src/` -- Individual page assets
`static/` -- Web-ready assets such as icons (will not be bundled with webpack)