cha0s/flecks
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: doc

Browse Source
This commit is contained in:
cha0s 2022-03-08 16:07:07 -06:00
parent 8667d32c14
commit f60d3544bd
2 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -10,8 +10,9 @@
## ⚠️ PROCEED AT YOUR OWN RISK ⚠️ ## ⚠️ PROCEED AT YOUR OWN RISK ⚠️
This is alpha software. There are undoubtedly many bugs that haven't yet been found. I reserve This is alpha software. There are undoubtedly many bugs that haven't yet been found.
the right to break all semantic versioning guarantees as long as the project is v1.x.x!
I reserve the right to break all semantic versioning guarantees as long as the project is v1.x.x!
**You've been warned!** **You've been warned!**
</div> </div>
@ -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 Of course, flecks strives to provide powerful defaults that minimize the need to override
configuration. 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 ### 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 Hooks are how everything happens in flecks. There are many hooks and they will not be treated
exhaustively here. See the documentation page above. 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. ...and so many more.
We didn't even touch on [gather hooks](ADDME), [provider hooks](ADDME), [decorator hooks](ADDME), We didn't even touch on gather hooks, provider hooks, decorator hooks,
and so many more. Please see the [hook documentation page](ADDME) for the full rundown on all of and so many more. Please see the
the wonderful things hooks can do for you. [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.

6
packages/core/build/dox/concepts/hooks.md
View File

@ -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. `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).
&nbsp; &nbsp;
@ -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. 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).
&nbsp; &nbsp;
@ -283,7 +283,7 @@ is *exactly equivalent* to the decorator example above.
} }
``` ```
Decorator hooks are ordered. Decorator hooks are [ordered](#ordered-hooks).
## Ordered hooks ## Ordered hooks