Add experimental combinator handling
I have a few combinator ideas that I'd like to try adding but I still haven't fully fleshed them out yet. In order to reduce breaking people's setup, this introduces a new `experimental` flag on combinators that separates them on the docs website to let users know that their design may not be fully finalized yet.
This commit is contained in:
parent
7acd363b6d
commit
731ba22f60
5 changed files with 45 additions and 12 deletions
|
|
@ -51,7 +51,9 @@
|
|||
combinatorDocs =
|
||||
let
|
||||
allCombinators =
|
||||
(import (docsFileSet + /lib/combinators.nix) pkgs (throw "Docs must not depend on jail arg")).docs;
|
||||
(import (docsFileSet + /lib/combinators.nix) { inherit pkgs; } (
|
||||
throw "Docs must not depend on jail arg"
|
||||
)).docs;
|
||||
|
||||
formatSection =
|
||||
filter:
|
||||
|
|
@ -82,7 +84,7 @@
|
|||
|
||||
${hr}
|
||||
|
||||
${formatSection (v: !(is "includedInBasePermissions" v || is "internal" v))}
|
||||
${formatSection (v: !(is "includedInBasePermissions" v || is "internal" v || is "experimental" v))}
|
||||
|
||||
${hr}
|
||||
|
||||
|
|
@ -93,6 +95,20 @@
|
|||
`basePermissions`](advanced-configuration.md#basepermissions).
|
||||
|
||||
${formatSection (is "includedInBasePermissions")}
|
||||
|
||||
${hr}
|
||||
|
||||
## Experimental Combinators
|
||||
|
||||
The following combinators are experimental, and may be removed, or
|
||||
have breaking changes in the future. Please reach out if you have any
|
||||
feedback on them.
|
||||
|
||||
Using these combinators will emit an evaluation warning, you can
|
||||
suppress this warning with
|
||||
[suppressExperimentalWarnings](advanced-configuration.md#suppressexperimentalwarnings).
|
||||
|
||||
${formatSection (is "experimental")}
|
||||
'';
|
||||
|
||||
mkdocsSettings = {
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue