docs: add plugins concept page - #49
Draft
djsauble wants to merge 2 commits into
Draft
Conversation
The `[plugins]` manifest section shipped in flox/flox schema v1.14.0 (experimental) with only man-page documentation. This adds the concepts page covering both experiences: installing/configuring a plugin, and writing one via a profile.d script and flox_plugin_data. Anchored on the secrets-retrieval use case from concepts/secrets-management.mdx, with a note that plugins are a general-purpose mechanism. The man page itself (man/manifest.toml.mdx) isn't touched here — it's synced automatically from flox/flox's `latest` branch once 1.14.0 ships, per the existing sync-man-pages workflow.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
djsauble
commented
Jul 28, 2026
djsauble
commented
Jul 28, 2026
…hored
Address review: whether a missing [plugins.<name>] table aborts
activation is determined by how the plugin's own script calls
flox_plugin_data, not something Flox guarantees. Reworked both the
consumer-facing note and the writing-a-plugin example to show this
as an explicit choice (fail hard vs. fail soft).
Also switch the example script from a bare `jq` call to `${_jq:-jq}`,
matching how Flox's own activation helpers resolve jq for profile.d
scripts to use.
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
concepts/plugins.mdxfor the[plugins]manifest section (schema v1.14.0, experimental, flox/flox#4535).profile.dscript +flox_plugin_data) as a producer.on-activatepattern fromconcepts/secrets-management.mdxinto an installable component — with an explicit "Beyond secrets" section noting[plugins]is general-purpose, not secrets-specific.concepts/secrets-management.mdxto the new page, and a nav entry indocs.json.Not included
man/manifest.toml.mdx— this is synced automatically from flox/flox'slatestbranch by the scheduledsync-man-pagesworkflow, which only tracks released stable, notmain.[plugins]docs will appear there once 1.14.0 ships as latest, same as the auto-activation man pages deferred in docs(auto-activation): drop feature-flag framing for Flox 1.14.0 #48. No manual edit needed or wanted here.Test plan
vale concepts/plugins.mdx concepts/secrets-management.mdx— 0 errorsmint broken-links— no broken linksmint dev🤖 Generated with Claude Code