From f60d3544bdaced34b96e484de707338c8af54b1e Mon Sep 17 00:00:00 2001 From: cha0s Date: Tue, 8 Mar 2022 16:07:07 -0600 Subject: [PATCH] chore: doc --- README.md | 16 +++++++++------- packages/core/build/dox/concepts/hooks.md | 6 +++--- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f4abf21..839f9a7 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,9 @@ ## ⚠️ PROCEED AT YOUR OWN RISK ⚠️ - This is alpha software. There are undoubtedly many bugs that haven't yet been found. I reserve - the right to break all semantic versioning guarantees as long as the project is v1.x.x! + This is alpha software. There are undoubtedly many bugs that haven't yet been found. + + I reserve the right to break all semantic versioning guarantees as long as the project is v1.x.x! **You've been warned!** @@ -88,7 +89,7 @@ configuration in your `build` directory on a case-by-case basis. Of course, flecks strives to provide powerful defaults that minimize the need to override configuration. -See [the build directory documentation page](packages/core/build/dox/build.md) for more details. +See the [build directory documentation page](packages/core/build/dox/build.md) for more details. --- @@ -124,7 +125,7 @@ server application with no interesting work to do. ### Hooks -Documentation page: https://github.com/cha0s/flecks/blob/gh-pages/hooks.md +See the [hook documentation page](./packages/core/build/dox/concepts/hooks.md) Hooks are how everything happens in flecks. There are many hooks and they will not be treated exhaustively here. See the documentation page above. @@ -161,6 +162,7 @@ Just to give you an idea of the power of hooks, some will be listed here: ...and so many more. -We didn't even touch on [gather hooks](ADDME), [provider hooks](ADDME), [decorator hooks](ADDME), -and so many more. Please see the [hook documentation page](ADDME) for the full rundown on all of -the wonderful things hooks can do for you. +We didn't even touch on gather hooks, provider hooks, decorator hooks, +and so many more. Please see the +[hook documentation page](./packages/core/build/dox/concepts/hooks.md) for the full rundown on all +of the wonderful things hooks can do for you. diff --git a/packages/core/build/dox/concepts/hooks.md b/packages/core/build/dox/concepts/hooks.md index 1466b50..bf87072 100755 --- a/packages/core/build/dox/concepts/hooks.md +++ b/packages/core/build/dox/concepts/hooks.md @@ -35,7 +35,7 @@ See: [function composition](https://www.educative.io/edpresso/function-compositi `initial` is passed to the first implementation, which returns a result which is passed to the second implementation, which returns a result which is passed to the third implementation, etc. -Composed hooks are ordered. +Composed hooks are [ordered](#ordered-hooks).   @@ -71,7 +71,7 @@ Invokes hook implementations one at a time, their results being passed to the re Invokes all hook implementations, one after another. In the async variant, each implementation's result is `await`ed before invoking the next implementation. -Sequential hooks are ordered. +Sequential hooks are [ordered](#ordered-hooks).   @@ -283,7 +283,7 @@ is *exactly equivalent* to the decorator example above. } ``` -Decorator hooks are ordered. +Decorator hooks are [ordered](#ordered-hooks). ## Ordered hooks