FAQ

Board ... is not ready, what does it mean?

It means that the board is still doing the checks for the first time, the results are not ready. If this message always stays, please make sure:

1. Each check function has a timeout mechanism so that it won't take arbitrarily long time, in case of time-out, return a failed Future (e.g. call Future.failed), then the underlying check's status will be resolved as Unknown

2. Exceptions should be handled in the context of a Future in a check function, for example, a check function may have one of the following patterns:

() => Future {
  /* ... throw an exception here is ok */
}
() => {
  // ...
  Future.failed(/* wrap an exception here is ok*/)
}
() => {
  // ...
  // You should not let an exception be thrown outside a Future, otherwise the board will hang
  // ...
  Future.success(/* ... */) 
}