Skip to content

OkayHQ/ee-handbook

Repository files navigation

Engineering Effectiveness Handbook

Welcome to the Engineering Effectiveness Handbook! We are the team of engineering leaders behind Okay and the authors of the first version of this handbook.

After talking to hundreds of engineering leaders, we know 2 things:

  • the vast majority of engineering teams want to become more effective
  • but not everyone knows where to start

This handbook intends to fill that gap. Our goal is to build the first practical and actionable guide to engineering effectiveness.

We decided to give this work to the community under CC-BY-SA and we welcome contributions, which you can provide in three main ways:

All content is in Markdown files under the 📁 content folder.

We hope you'll enjoy reading this handbook!

Run Locally

Setup

Install dependencies:

yarn install

Development

yarn dev

Static Generation

This will create the dist/ directory for publishing to static hosting:

yarn generate

To preview the static generated app, run yarn start

For detailed explanation on how things work, checkout nuxt/content and @nuxt/content theme docs.