Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document feature flags for a given release #482

Open
pdaoust opened this issue Oct 24, 2024 · 3 comments
Open

Document feature flags for a given release #482

pdaoust opened this issue Oct 24, 2024 · 3 comments
Assignees

Comments

@pdaoust
Copy link
Collaborator

pdaoust commented Oct 24, 2024

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.

@pdaoust pdaoust self-assigned this Oct 24, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Holochain Oct 24, 2024
@zippy zippy moved this from Backlog to Ready for refinement in Holochain Oct 28, 2024
@ThetaSinner
Copy link
Member

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

@zippy zippy moved this from Ready for refinement to Ready in Holochain Oct 31, 2024
@pdaoust
Copy link
Collaborator Author

pdaoust commented Oct 31, 2024

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.

@pdaoust pdaoust moved this from Ready to In progress in Holochain Nov 19, 2024
@pdaoust
Copy link
Collaborator Author

pdaoust commented Dec 13, 2024

Resolved in #499

@pdaoust pdaoust moved this from In progress to In review in Holochain Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In review
Development

No branches or pull requests

2 participants