An experimental repository of documents describing the standardized FLYWHEEL way.
- The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
- In the event of a contradiction between ongoing way and the standard way, the ongoing one MAY take precedence over the documentation. However, all developers, repositories, and any other things related to our DX SHOULD make an effort to keep following the standard.
- All documents MUST be considered as living.
To set up a new machine, first clone this repository and then run the included
When you notice that the origin/master is updated, run
bin/setup again at the edge commit.
Run the local server with
yarn start. This command automatically open docs in default browser. To disable this behavior you may use
yarn start # yarn start --no-open
Every push to
master branch will upload documents to the Mouseion. Deploys happen automatically.