diff --git a/README.md b/README.md index 152b9df..e300e02 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ Flecks applications contain a `build` directory with a `flecks.yml` that defines Flecks strives to provide powerful defaults that minimize the need to override configuration. -[Learn more about the build directory](packages/core/build/dox/build.md). +[Learn more about the build directory](packages/core/build/dox/concepts/build.md). The simplest example of a flecks server application: diff --git a/packages/core/build/dox/build.md b/packages/core/build/dox/concepts/build.md similarity index 92% rename from packages/core/build/dox/build.md rename to packages/core/build/dox/concepts/build.md index 110ff06..b816d98 100644 --- a/packages/core/build/dox/build.md +++ b/packages/core/build/dox/concepts/build.md @@ -5,6 +5,9 @@ The `build` directory is where build-time configuration is specified. The prime example of this for Flecks is `flecks.yml`, but it extends to other more general configuration such as `.eslintrc.js`, `babel.config.js`, etc. +For a list of all build configuration, see the +[build configuration page](https://github.com/cha0s/flecks/blob/gh-pages/build-configs.md) + ## `flecks.yml` ⛏️ `flecks.yml` specifies the flecks that compose your project. @@ -30,6 +33,9 @@ ID to, say, `'example'`, would look like this: '@flecks/fleck': {} ``` +See [the generated configuration page](https://github.com/cha0s/flecks/blob/gh-pages/config.md) +for a list of all configuration. + ### Aliasing 🕵️‍♂️ Flecks may be aliased to alternative paths.