Skip to content

docs(deactivate): add flox-deactivate man page and deactivation section [DO NOT MERGE]#17

Open
djsauble wants to merge 3 commits into
mainfrom
daniel/dev-88-add-deactivate-docs
Open

docs(deactivate): add flox-deactivate man page and deactivation section [DO NOT MERGE]#17
djsauble wants to merge 3 commits into
mainfrom
daniel/dev-88-add-deactivate-docs

Conversation

@djsauble
Copy link
Copy Markdown

@djsauble djsauble commented May 20, 2026

NOTE 1: This PR is blocked on flox deactivate shipping. Feel free to review, but do not merge.

NOTE 2: This PR currently duplicates the man page from flox/flox#4264. Once we have automation to pull man pages into docs, this can be dropped.

Summary

  • Adds man/flox-deactivate.mdx documenting the flox deactivate command — what it tears down (env vars, shell customizations, profile.deactivate.${shell} scripts), layered/innermost behavior with -d <path> for non-innermost layers, subshell shorthand for exit, and auto-activation suppression behavior.
  • Registers the new page in docs.json under the Environments CLI reference group.
  • Adds a "Deactivating environments" section to concepts/activation.mdx (between Attaching and Development vs. runtime mode) and a one-line mention next to the existing exit / Ctrl-D callout in the Subshell section.
  • Cross-links from man/flox-activate.mdx (DESCRIPTION note + SEE ALSO).

Documents the designed flox deactivate behavior from the auto-activate slice, but it excludes any mention of the auto-activation feature. Companion CLI man page source PR: flox/flox#4264.

Tutorials that currently tell users to exit (flox-5-minutes, creating-environments, customizing-environments, layering-multiple-environments) are intentionally untouched — they'll be revisited in the follow-up auto-activation docs slice.

Linear: DEV-88

@linear-code
Copy link
Copy Markdown

linear-code Bot commented May 20, 2026

DEV-88 Add `deactivate` docs

  • Rewrite the man page for flox-deactivate
  • Add a note to activate man page and/or activation docs mentioning deactivate
  • I don't think we need a separate docs page other than the man page just for deactivate, but we could consider that as well

Review in Linear

@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 20, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
flox 🟢 Ready View Preview May 20, 2026, 6:29 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread concepts/activation.mdx Outdated
Comment thread concepts/activation.mdx Outdated
Comment thread man/flox-deactivate.mdx Outdated
Comment thread man/flox-deactivate.mdx Outdated
Comment thread man/flox-deactivate.mdx Outdated
Comment thread man/flox-deactivate.mdx Outdated
Comment thread man/flox-deactivate.mdx Outdated
djsauble and others added 2 commits May 20, 2026 16:20
- Add a "Deactivating environments" section to concepts/activation.mdx
  covering reversibility, profile.deactivate scripts, layered envs, and
  the subshell shorthand for `exit`.
- Add a one-line mention next to the existing `exit` / `Ctrl-D` callout
  in the Subshell section.
- Register the new man/flox-deactivate page in docs.json under the
  Environments group of the CLI reference nav.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- Add man/flox-deactivate.mdx mirroring the pandoc source at
  cli/flox/doc/flox-deactivate.md in flox/flox.
- Add a DESCRIPTION note and SEE ALSO entry in man/flox-activate.mdx
  pointing at the new page.

Scoped to the initial behavior — only deactivates the innermost
environment. Layered/non-innermost selection (-d/-r) is deferred.

These pages are duplicated from flox/flox today (the two repos hold
parallel hand-maintained copies). This commit is kept last so it can
be cleanly reverted if we later land automation that pulls man pages
directly from flox/flox into this repo.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Comment thread concepts/activation.mdx Outdated
@djsauble djsauble marked this pull request as ready for review May 21, 2026 17:27
@djsauble djsauble changed the title docs(deactivate): add flox-deactivate man page and deactivation section docs(deactivate): add flox-deactivate man page and deactivation section [DO NOT MERGE] May 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant