Document feature flags for a given release

Open pdaoust opened this issue 1 year ago • 3 comments

With unstable features moving behind feature flags that are off by default, the flags (and the means to enable them) should be documented. The means is already documented in Holonix; there's a DRY question there.

Oct 24 '24 16:10 pdaoust

Example of documenting feature flags in docs is here https://crates.io/crates/wasmer

Oct 31 '24 16:10 ThetaSinner

AC: In a discoverable location (my plan is to put it on an 0.4 upgrade guide, plus the top level module docs for relevant crates), all the feature flags are documented, along with instructions (or a link to the instructions on the Holonix readme) on how to use them.

Oct 31 '24 16:10 pdaoust

Resolved in #499

Dec 13 '24 22:12 pdaoust