docs(auto-activation): add auto-activation concept page and man pages (DEV-89)#31
Open
djsauble wants to merge 8 commits into
Open
docs(auto-activation): add auto-activation concept page and man pages (DEV-89)#31djsauble wants to merge 8 commits into
djsauble wants to merge 8 commits into
Conversation
…DEV-89) - New concepts/auto-activation.mdx covering enablement (the BETA feature flag plus the prompt hook), the allow/deny consent flow, nested environments, and deactivation, written against the actual implementation. - Cross-link to it from concepts/activation.mdx. - Regenerate man/flox-activate and man/flox-config and add man/flox-activate-allow and man/flox-activate-deny, synced from the flox/flox man-page sources. - Add the new pages to the docs.json navigation. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
djsauble
commented
Jun 18, 2026
Contributor
Author
There was a problem hiding this comment.
Let's also add a line to the AGENTS.md in this repository that man pages shouldn't be edited directly in this repository since they're automatically synced from the flox/flox repo.
this is already documented under the "Man pages are generated — do not edit directly" section:
Everything under
man/is generated from the man page sources in the flox/flox repo (cli/flox/doc/*.md).
- Do not edit
man/*.mdxdirectly — changes will be overwritten by the next sync.- To fix or update a man page, edit the source in flox/flox (
cli/flox/doc/), then regenerate:./scripts/sync-man-pages.sh <path-to-flox-repo> ./man- New pages also need a navigation entry in
docs.jsonunder the "CLI reference" tab.
Man pages under man/ are generated from flox/flox via sync-man-pages.sh, so they (and their docs.json "CLI reference" entries) land with that sync rather than this PR. The auto-activation man pages come from flox/flox#4407. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
These man pages are synced from flox/flox; their nav entries belong with that sync. The hand-authored concepts/auto-activation entry stays. docs.json is not auto-updated by the sync, so nav entries are maintained by hand (see AGENTS.md). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the experimental auto-activation feature on the docs site
(DEV-89).
Auto-activation activates an environment when you
cdinto a directory thatcontains it and deactivates it when you leave.
Written against the actual implementation at the top of the auto-activate
stack — this supersedes the earlier exploration in
flox/floxdocs#456, whose behavior
had diverged (and which lived in the now-stale
floxdocsrepo).Changes (hand-authored content only)
concepts/auto-activation.mdx: enablement (the BETAauto_activatefeature flag plus the prompt hook installed by an in-place activation),
how the hook works, the allow/deny consent flow, nested environments,
deactivation/layer-peeling, and a comparison with manual activation.
concepts/activation.mdx.docs.jsonnav entry for the new concept page.Man pages are out of scope here
Per review, the
man/*.mdxchanges and theirdocs.jsonnav entries wereremoved — those are generated from the flox/flox sources via
scripts/sync-man-pages.shand should land via that sync (the auto-activationman pages come from flox/flox#4407). I confirmed
docs.jsonis notauto-updated by the sync, so the concept-page nav entry is added here by hand.
Ordering note 👀
The concept page links to
/man/flox-activate-allowand/man/flox-activate-deny, which don't exist until the man pages are synced fromflox/flox#4407. Merge after that sync so
mint broken-linksis clean.