Skip to content

docs(default): add example default environments - #99

Merged
djsauble merged 1 commit into
mainfrom
claude/charming-fermat-syut2t
Sep 28, 2026
Merged

djsauble merged 1 commit into
mainfrom
claude/charming-fermat-syut2t

Conversation

@djsauble

@djsauble djsauble commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Adds a new tutorial page, Example default environments (tutorials/default-environment-examples.mdx). It answers a common question: "What should go in my default environment?"

The page starts with guidance on what belongs in a default environment and what belongs in a project environment. It then gives four manifests you can copy. Each one shows a different part of the manifest:

Example Shows you how to use
Everyday essentials Plain [install], built with flox install
Shell power user [vars] and per-shell [profile] integrations
macOS and Linux Per-package systems for OS-specific tools
Team baseline [include] a FloxHub environment, then add personal tools

None of the examples set options.systems, because the default (aarch64-darwin, aarch64-linux, and x86_64-linux) already covers them. The macOS and Linux example narrows individual packages with per-package systems, and uses only non-deprecated systems.

Other changes

  • tutorials/default-environment.mdx: new Deciding what to install section that links to the examples
  • tutorials/migrations/homebrew.mdx: links to the examples from the section on what belongs in the default environment
  • tutorials/layering-multiple-environments.mdx: adds the examples to Where to next
  • docs.json: adds the page to the nav, after the default environment tutorial
  • llms.txt: regenerated with the new entry

Fixes DEV-29

🤖 Generated with Claude Code

@mintlify

mintlify Bot commented Sep 25, 2026 •

Copy link
Copy Markdown

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

Project Status Preview Updated
flox 🟢 Ready View Preview Sep 28, 2026, 9:50 PM

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

That makes it the right home for tools you use everywhere:

- General-purpose command-line tools, such as `git`, `curl`, and `jq`
- Your editor, terminal multiplexer, and shell prompt

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's worth it adding a 1-2 examples for each tool in parenthesis?

- General-purpose command-line tools, such as `git`, `curl`, and `jq`
- Your editor, terminal multiplexer, and shell prompt
- Coding agents, such as Claude Code and Codex
- CLIs for services you use across projects, such as cloud providers and GitHub

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also here we could recommend aws-cli and such

@tanjadev tanjadev left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

gnused.pkg-path = "gnused"
gnused.systems = ["aarch64-darwin"]
gnutar.pkg-path = "gnutar"
gnutar.systems = ["aarch64-darwin"]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

off-topic:
I wish we had a possibility to group packages by system..

Add a tutorial page with four example default environments, and guidance
on what belongs in a default environment versus a project environment.
Each example shows a different part of the manifest:

- Everyday essentials: plain [install], built with flox install
- Shell power user: [vars] and per-shell [profile] integrations
- macOS and Linux: per-package systems for OS-specific tools
- Team baseline: [include] a FloxHub environment, then add personal tools

The examples don't set options.systems, since the default
(aarch64-darwin, aarch64-linux, and x86_64-linux) already covers them,
and they don't use the deprecated x86_64-darwin.

Link to the page from the default environment tutorial, the Homebrew
migration guide, and the layering tutorial, add it to the nav, and
regenerate llms.txt.

Refs: DEV-29

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@djsauble
djsauble force-pushed the claude/charming-fermat-syut2t branch from 930b07e to 0a8b181 Compare September 28, 2026 21:50
@djsauble
djsauble added this pull request to the merge queue Sep 28, 2026
Merged via the queue into main with commit aeb63a5 Sep 28, 2026
5 checks passed
@djsauble
djsauble deleted the claude/charming-fermat-syut2t branch September 28, 2026 21:53

This branch was successfully deployed

1 active deployment
staging — 0a8b1810 Deployed Sep 28, 2026 by mintlify[bot]
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.

2 participants