From f2f53d5b57ec2363e2b333999bb3c2d21abfbf44 Mon Sep 17 00:00:00 2001 From: Daniel Sauble Date: Wed, 1 Oct 2025 12:28:19 -0700 Subject: [PATCH 1/7] Flatten the Cookbook section of the nav --- docs/concepts/manifest-builds.md | 2 +- docs/index.md | 2 +- docs/{cookbook => }/languages/c.md | 2 +- docs/{cookbook => }/languages/go.md | 6 +- docs/{cookbook => }/languages/jvm.md | 2 +- docs/{cookbook => }/languages/nodejs.md | 4 +- docs/{cookbook => }/languages/python.md | 2 +- docs/{cookbook => }/languages/ruby.md | 4 +- docs/{cookbook => }/languages/rust.md | 4 +- docs/tutorials/customizing-environments.md | 2 +- mkdocs.yml | 503 ++++++++++----------- 11 files changed, 265 insertions(+), 268 deletions(-) rename docs/{cookbook => }/languages/c.md (96%) rename docs/{cookbook => }/languages/go.md (93%) rename docs/{cookbook => }/languages/jvm.md (97%) rename docs/{cookbook => }/languages/nodejs.md (95%) rename docs/{cookbook => }/languages/python.md (99%) rename docs/{cookbook => }/languages/ruby.md (95%) rename docs/{cookbook => }/languages/rust.md (98%) diff --git a/docs/concepts/manifest-builds.md b/docs/concepts/manifest-builds.md index ff57f98b..e9e95fec 100644 --- a/docs/concepts/manifest-builds.md +++ b/docs/concepts/manifest-builds.md @@ -197,4 +197,4 @@ For example, [this section][go-example] contains an example build for the Go lan [pkg-groups]: ../reference/command-reference/manifest.toml.md#package-descriptors [grpc]: https://grpc.io/ [organizations-concept]: ./organizations.md -[go-example]: ../cookbook/languages/go.md#build-with-flox +[go-example]: ../languages/go.md#build-with-flox diff --git a/docs/index.md b/docs/index.md index a129558f..5bd18fbb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -143,7 +143,7 @@ The Flox product and engineering teams love to hear directly from users. Your qu [delete]: ./reference/command-reference/flox-delete.md [list]: ./reference/command-reference/flox-list.md [manifest]: ./reference/command-reference/manifest.toml.md -[rust-cookbook]: ./cookbook/languages/rust.md +[rust-cookbook]: ./languages/rust.md [multi-arch]: ./tutorials/multi-arch-environments.md [config]: ./reference/command-reference/flox-config.md [services]: ./concepts/services.md diff --git a/docs/cookbook/languages/c.md b/docs/languages/c.md similarity index 96% rename from docs/cookbook/languages/c.md rename to docs/languages/c.md index 47c8946b..d6f4b372 100644 --- a/docs/cookbook/languages/c.md +++ b/docs/languages/c.md @@ -55,4 +55,4 @@ clangStdenv.mkDerivation { } ``` -[build-concept]: ../../concepts/builds.md +[build-concept]: ../concepts/builds.md diff --git a/docs/cookbook/languages/go.md b/docs/languages/go.md similarity index 93% rename from docs/cookbook/languages/go.md rename to docs/languages/go.md index a6ce8dd1..cb93b262 100644 --- a/docs/cookbook/languages/go.md +++ b/docs/languages/go.md @@ -107,6 +107,6 @@ buildGoModule { } ``` -[build-concept]: ../../concepts/builds.md -[pure-builds-section]: ../../concepts/manifest-builds.md#pure-builds -[nix-expression-hashes]: ../../concepts/nix-expression-builds.md#generating-hashes +[build-concept]: ../concepts/builds.md +[pure-builds-section]: ../concepts/manifest-builds.md#pure-builds +[nix-expression-hashes]: ../concepts/nix-expression-builds.md#generating-hashes diff --git a/docs/cookbook/languages/jvm.md b/docs/languages/jvm.md similarity index 97% rename from docs/cookbook/languages/jvm.md rename to docs/languages/jvm.md index ea74b6e1..159cbbd5 100644 --- a/docs/cookbook/languages/jvm.md +++ b/docs/languages/jvm.md @@ -44,4 +44,4 @@ Note that `pwd` will return the location from which the built artifact is run, n [gradle]: https://gradle.org/ [shadow]: https://gradleup.com/shadow/ -[build-concept]: ../../concepts/builds.md +[build-concept]: ../concepts/builds.md diff --git a/docs/cookbook/languages/nodejs.md b/docs/languages/nodejs.md similarity index 95% rename from docs/cookbook/languages/nodejs.md rename to docs/languages/nodejs.md index 54938175..53ba5ce7 100644 --- a/docs/cookbook/languages/nodejs.md +++ b/docs/languages/nodejs.md @@ -97,5 +97,5 @@ buildNpmPackage (final: { }); ``` -[build-concept]: ../../concepts/builds.md -[pure-builds-section]: ../../concepts/manifest-builds.md#pure-builds +[build-concept]: ../concepts/builds.md +[pure-builds-section]: ../concepts/manifest-builds.md#pure-builds diff --git a/docs/cookbook/languages/python.md b/docs/languages/python.md similarity index 99% rename from docs/cookbook/languages/python.md rename to docs/languages/python.md index 84697324..58cddb87 100644 --- a/docs/cookbook/languages/python.md +++ b/docs/languages/python.md @@ -355,4 +355,4 @@ runtime-packages = [ ] ``` -[build-concept]: ../../concepts/builds.md +[build-concept]: ../concepts/builds.md diff --git a/docs/cookbook/languages/ruby.md b/docs/languages/ruby.md similarity index 95% rename from docs/cookbook/languages/ruby.md rename to docs/languages/ruby.md index 6b10afde..9df5e676 100644 --- a/docs/cookbook/languages/ruby.md +++ b/docs/languages/ruby.md @@ -82,5 +82,5 @@ command = """ sandbox = "pure" ``` -[build-concept]: ../../concepts/builds.md -[pure-builds-section]: ../../concepts/manifest-builds.md#pure-builds +[build-concept]: ../concepts/builds.md +[pure-builds-section]: ../concepts/manifest-builds.md#pure-builds diff --git a/docs/cookbook/languages/rust.md b/docs/languages/rust.md similarity index 98% rename from docs/cookbook/languages/rust.md rename to docs/languages/rust.md index bbc21eb9..a0bd353f 100644 --- a/docs/cookbook/languages/rust.md +++ b/docs/languages/rust.md @@ -289,5 +289,5 @@ rustPlatform.buildRustPackage { [custom-toolchains]: https://github.com/zmitchell/rust-toolchains [esp32]: https://www.espressif.com/en/products/socs/esp32 [risc-v]: https://en.wikipedia.org/wiki/RISC-V -[build-concept]: ../../concepts/builds.md -[pure-builds-section]: ../../concepts/manifest-builds.md#pure-builds +[build-concept]: ../concepts/builds.md +[pure-builds-section]: ../concepts/manifest-builds.md#pure-builds diff --git a/docs/tutorials/customizing-environments.md b/docs/tutorials/customizing-environments.md index d1761382..cab3b597 100644 --- a/docs/tutorials/customizing-environments.md +++ b/docs/tutorials/customizing-environments.md @@ -176,7 +176,7 @@ mycli [environment_concept]: ../concepts/environments.md [flox_activate]: ../reference/command-reference/flox-activate.md [multi-arch-guide]: ./multi-arch-environments.md -[rust_guide]: ../cookbook/languages/rust.md +[rust_guide]: ../languages/rust.md [flox_init]: ../reference/command-reference/flox-init.md [activation_concept]: ../concepts/activation.md [fish_shell]: https://fishshell.com/ diff --git a/mkdocs.yml b/mkdocs.yml index 26637d56..f90c4755 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,7 +25,7 @@ repo_url: "https://github.com/flox/flox" copyright: "Copyright 2025 Flox. All rights reserved." extra: - FLOX_VERSION: !ENV [FLOX_VERSION, 'X.Y.Z'] + FLOX_VERSION: !ENV [FLOX_VERSION, "X.Y.Z"] FLOX_PUBLIC_KEY: "flox-cache-public-1:7F4OyH7ZCnFhcze3fJdfyXYLQw/aV7GEed86nQ7IsOs=" generator: false analytics: @@ -34,44 +34,43 @@ extra: nav: - Introduction: index.md - Install Flox: - - Install: install-flox/install.md - - Uninstall: install-flox/uninstall.md + - Install: install-flox/install.md + - Uninstall: install-flox/uninstall.md - Flox in 5 minutes: flox-5-minutes.md - Tutorials: - - Creating environments: tutorials/creating-environments.md - - The default environment: tutorials/default-environment.md - - Sharing environments: tutorials/sharing-environments.md - - Layering multiple environments: tutorials/layering-multiple-environments.md - - Customizing the shell environment: tutorials/customizing-environments.md - - Designing multi-arch environments: tutorials/multi-arch-environments.md - - Building and publishing packages: tutorials/build-and-publish.md - - Running Flox in CI/CD: tutorials/ci-cd.md - - Designing cross-platform environments: tutorials/multi-arch-environments.md - - Reusing and combining developer environments: tutorials/composition.md - - Flox + CUDA: tutorials/cuda.md - - Migration guides: - - ... | flat | tutorials/migrations/* + - Creating environments: tutorials/creating-environments.md + - The default environment: tutorials/default-environment.md + - Sharing environments: tutorials/sharing-environments.md + - Layering multiple environments: tutorials/layering-multiple-environments.md + - Customizing the shell environment: tutorials/customizing-environments.md + - Designing multi-arch environments: tutorials/multi-arch-environments.md + - Building and publishing packages: tutorials/build-and-publish.md + - Running Flox in CI/CD: tutorials/ci-cd.md + - Designing cross-platform environments: tutorials/multi-arch-environments.md + - Reusing and combining developer environments: tutorials/composition.md + - Flox + CUDA: tutorials/cuda.md + - Migration guides: + - ... | flat | tutorials/migrations/* - Concepts: - - Environments: concepts/environments.md - - Activating environments: concepts/activation.md - - FloxHub: concepts/floxhub.md - - Generations: concepts/generations.md - - Catalog and Packages: concepts/packages-and-catalog.md - - Services: concepts/services.md - - Composing environments: concepts/composition.md - - Organizations: concepts/organizations.md - - Builds: concepts/builds.md - - Manifest builds: concepts/manifest-builds.md - - Nix expression builds: concepts/nix-expression-builds.md - - Publishing: concepts/publishing.md - - Flox vs. container workflows: concepts/flox-vs-containers.md - - Cookbook: - - Languages: - - ... | flat | cookbook/languages/* + - Environments: concepts/environments.md + - Activating environments: concepts/activation.md + - FloxHub: concepts/floxhub.md + - Generations: concepts/generations.md + - Catalog and Packages: concepts/packages-and-catalog.md + - Services: concepts/services.md + - Composing environments: concepts/composition.md + - Organizations: concepts/organizations.md + - Builds: concepts/builds.md + - Manifest builds: concepts/manifest-builds.md + - Nix expression builds: concepts/nix-expression-builds.md + - Publishing: concepts/publishing.md + - Flox vs. container workflows: concepts/flox-vs-containers.md + - Languages: + - ... | flat | languages/* - Reference: - - Flox manual: - - reference/command-reference/flox.md - - ... | flat | reference/command-reference/* + - Flox manual: + - reference/command-reference/flox.md + - ... | flat | reference/command-reference/* strict: true validation: @@ -88,225 +87,223 @@ extra_css: - css/extra.css theme: - name: material - - custom_dir: overrides - - language: en - direction: ltr - - favicon: img/favicon.ico - logo: img/logo.svg - - font: false - - palette: - - # Palette toggle for light mode - - media: "(prefers-color-scheme: light)" - scheme: default - primary: custom - accent: custom - toggle: - icon: material/brightness-7 - name: Switch to dark mode - - # Palette toggle for dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: custom - accent: custom - toggle: - icon: material/brightness-4 - name: Switch to light mode - - icon: - # Repository icon - # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-icon - repo: fontawesome/brands/github - - # Admonition icons - # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonition-icons - admonition: - announce: material/bullhorn - - features: - # Clicks on all internal links will be intercepted and dispatched via - # XHR without fully reloading the page. - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading - - navigation.instant # Instant loading - - navigation.instant.prefetch # Instant prefetching - - navigation.instant.progress # Progress indicator - - navigation.tracking # Anchor tracking - # - navigation.tabs # Navigation tabs - # - navigation.sections # Navigation sections - - navigation.expand # Navigation expansion - - navigation.path # Navigation path aka Breadcrumbs - - navigation.prune # Navigation pruning - # - navigation.indexes # Section index pages - - navigation.top # Back-to-top button - - toc.follow # Anchor following - # - toc.integrate # Navigation integration - - navigation.footer - - # The search will display the likeliest completion for the last word - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions - - search.suggest - - search.highlight - - search.share - - # Code blocks - # - content.code.copy # Enable copy button on a case-by-case basis - # See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button - - content.code.select # Code selection button - # See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations - - content.code.annotate # Code annotations - - # Footnote tooltips - # https://squidfunk.github.io/mkdocs-material/reference/footnotes/#footnote-tooltips - - content.footnote.tooltips - - # Improved tooltips - # https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips - - content.tooltips - -markdown_extensions: - # Admonitions - # https://squidfunk.github.io/mkdocs-material/reference/admonitions/ - - admonition - - pymdownx.details - - pymdownx.superfences - - # Annotations - # https://squidfunk.github.io/mkdocs-material/reference/annotations/ - - attr_list - - md_in_html - - pymdownx.superfences - - # Buttons - # https://squidfunk.github.io/mkdocs-material/reference/buttons/ - - attr_list + name: material + + custom_dir: overrides + + language: en + direction: ltr + + favicon: img/favicon.ico + logo: img/logo.svg + + font: false + + palette: + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: custom + accent: custom + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: custom + accent: custom + toggle: + icon: material/brightness-4 + name: Switch to light mode + + icon: + # Repository icon + # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-icon + repo: fontawesome/brands/github + + # Admonition icons + # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonition-icons + admonition: + announce: material/bullhorn + + features: + # Clicks on all internal links will be intercepted and dispatched via + # XHR without fully reloading the page. + # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading + - navigation.instant # Instant loading + - navigation.instant.prefetch # Instant prefetching + - navigation.instant.progress # Progress indicator + - navigation.tracking # Anchor tracking + # - navigation.tabs # Navigation tabs + # - navigation.sections # Navigation sections + - navigation.expand # Navigation expansion + - navigation.path # Navigation path aka Breadcrumbs + - navigation.prune # Navigation pruning + # - navigation.indexes # Section index pages + - navigation.top # Back-to-top button + - toc.follow # Anchor following + # - toc.integrate # Navigation integration + - navigation.footer + + # The search will display the likeliest completion for the last word + # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions + - search.suggest + - search.highlight + - search.share # Code blocks - # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/ - - pymdownx.highlight: - anchor_linenums: true - line_spans: __span - pygments_lang_class: true - - pymdownx.inlinehilite - - pymdownx.snippets: - base_path: "docs/snippets" - - pymdownx.superfences - - # Content tabs - # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/ - - pymdownx.superfences - - pymdownx.tabbed: - alternate_style: true - - # Data tables - # https://squidfunk.github.io/mkdocs-material/reference/data-tables/ - - tables - - # Diagrams - # https://squidfunk.github.io/mkdocs-material/reference/diagrams/ - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format - - # Footnotes - # https://squidfunk.github.io/mkdocs-material/reference/footnotes/ - - footnotes - - # Formatting - # https://squidfunk.github.io/mkdocs-material/reference/formatting/ - - pymdownx.critic - - pymdownx.caret - - pymdownx.keys - - pymdownx.mark - - pymdownx.tilde - - # Grids - # https://squidfunk.github.io/mkdocs-material/reference/grids/ - - attr_list - - md_in_html - - # Icons, Emojis - # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/ - - attr_list - - pymdownx.emoji: - emoji_index: !!python/name:material.extensions.emoji.twemoji - emoji_generator: !!python/name:material.extensions.emoji.to_svg - - # Images - # https://squidfunk.github.io/mkdocs-material/reference/images/ - - attr_list - - md_in_html - - # Lists - # https://squidfunk.github.io/mkdocs-material/reference/lists/ - - def_list - - pymdownx.tasklist: - custom_checkbox: true - - # Tooltips - # https://squidfunk.github.io/mkdocs-material/reference/tooltips/ - - abbr - - attr_list - - pymdownx.snippets + # - content.code.copy # Enable copy button on a case-by-case basis + # See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button + - content.code.select # Code selection button + # See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations + - content.code.annotate # Code annotations -plugins: + # Footnote tooltips + # https://squidfunk.github.io/mkdocs-material/reference/footnotes/#footnote-tooltips + - content.footnote.tooltips + + # Improved tooltips + # https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips + - content.tooltips - # Excellent client-side search implementation, omitting the need for the - # integration of third-party services - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin - - search - - # The built-in optimize plugin automatically identifies and optimizes all - # media files as part of the build using compression and conversion - # techniques. - # https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin - - optimize - - # Lightbox - image zoom - # https://github.com/blueswen/mkdocs-glightbox - - glightbox: - touchNavigation: true - loop: false - effect: zoom - slide_effect: slide - width: 100% - height: auto - zoomable: true - draggable: true - skip_classes: - - custom-skip-class-name - auto_caption: false - caption_position: bottom - background: white - shadow: true - - # Simplifies configuring page titles and their order - # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin - - awesome-pages - - # Enables markdown files to be included in other markdown files - # https://github.com/mondeja/mkdocs-include-markdown-plugin - - include-markdown - - # Unleash the power of MkDocs with variables and macros - # https://github.com/fralau/mkdocs-macros-plugin - - macros - - # Support for D2 diagrams - # https://github.com/landmaj/mkdocs-d2-plugin - - d2 - - # Create page redirects (e.g. for moved/renamed pages) - # https://github.com/mkdocs/mkdocs-redirects - - redirects: - redirect_maps: - 'concepts/manifest.md': 'concepts/environments.md#manifesttoml' - 'install-flox.md': 'install-flox/install.md' +markdown_extensions: + # Admonitions + # https://squidfunk.github.io/mkdocs-material/reference/admonitions/ + - admonition + - pymdownx.details + - pymdownx.superfences + + # Annotations + # https://squidfunk.github.io/mkdocs-material/reference/annotations/ + - attr_list + - md_in_html + - pymdownx.superfences + + # Buttons + # https://squidfunk.github.io/mkdocs-material/reference/buttons/ + - attr_list + + # Code blocks + # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/ + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets: + base_path: "docs/snippets" + - pymdownx.superfences + + # Content tabs + # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/ + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + + # Data tables + # https://squidfunk.github.io/mkdocs-material/reference/data-tables/ + - tables + + # Diagrams + # https://squidfunk.github.io/mkdocs-material/reference/diagrams/ + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + # Footnotes + # https://squidfunk.github.io/mkdocs-material/reference/footnotes/ + + - footnotes + + # Formatting + # https://squidfunk.github.io/mkdocs-material/reference/formatting/ + - pymdownx.critic + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde + + # Grids + # https://squidfunk.github.io/mkdocs-material/reference/grids/ + - attr_list + - md_in_html + + # Icons, Emojis + # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/ + - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + # Images + # https://squidfunk.github.io/mkdocs-material/reference/images/ + + - attr_list + - md_in_html + + # Lists + # https://squidfunk.github.io/mkdocs-material/reference/lists/ + - def_list + - pymdownx.tasklist: + custom_checkbox: true + + # Tooltips + # https://squidfunk.github.io/mkdocs-material/reference/tooltips/ + - abbr + - attr_list + - pymdownx.snippets + +plugins: + # Excellent client-side search implementation, omitting the need for the + # integration of third-party services + # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin + - search + + # The built-in optimize plugin automatically identifies and optimizes all + # media files as part of the build using compression and conversion + # techniques. + # https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin + - optimize + + # Lightbox - image zoom + # https://github.com/blueswen/mkdocs-glightbox + - glightbox: + touchNavigation: true + loop: false + effect: zoom + slide_effect: slide + width: 100% + height: auto + zoomable: true + draggable: true + skip_classes: + - custom-skip-class-name + auto_caption: false + caption_position: bottom + background: white + shadow: true + + # Simplifies configuring page titles and their order + # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin + - awesome-pages + + # Enables markdown files to be included in other markdown files + # https://github.com/mondeja/mkdocs-include-markdown-plugin + - include-markdown + + # Unleash the power of MkDocs with variables and macros + # https://github.com/fralau/mkdocs-macros-plugin + - macros + + # Support for D2 diagrams + # https://github.com/landmaj/mkdocs-d2-plugin + - d2 + + # Create page redirects (e.g. for moved/renamed pages) + # https://github.com/mkdocs/mkdocs-redirects + - redirects: + redirect_maps: + "concepts/manifest.md": "concepts/environments.md#manifesttoml" + "install-flox.md": "install-flox/install.md" From 5f1197bd244853242df229a49218c60031a9e1b3 Mon Sep 17 00:00:00 2001 From: Daniel Sauble Date: Wed, 1 Oct 2025 12:43:31 -0700 Subject: [PATCH 2/7] Flatten the Reference section of the nav --- .flox/env/manifest.toml | 2 +- .gitignore | 2 +- docs/concepts/activation.md | 8 +++--- docs/concepts/builds.md | 2 +- docs/concepts/environments.md | 20 +++++++------- docs/concepts/flox-vs-containers.md | 14 +++++----- docs/concepts/floxhub.md | 14 +++++----- docs/concepts/generations.md | 8 +++--- docs/concepts/manifest-builds.md | 4 +-- docs/concepts/nix-expression-builds.md | 2 +- docs/concepts/packages-and-catalog.md | 8 +++--- docs/concepts/publishing.md | 10 +++---- docs/concepts/services.md | 2 +- docs/flox-5-minutes.md | 20 +++++++------- docs/index.md | 26 +++++++++---------- docs/tutorials/build-and-publish.md | 14 +++++----- docs/tutorials/ci-cd.md | 2 +- docs/tutorials/composition.md | 10 +++---- docs/tutorials/creating-environments.md | 12 ++++----- docs/tutorials/customizing-environments.md | 6 ++--- docs/tutorials/default-environment.md | 6 ++--- .../layering-multiple-environments.md | 8 +++--- docs/tutorials/migrations/homebrew.md | 12 ++++----- docs/tutorials/migrations/nvm.md | 2 +- docs/tutorials/multi-arch-environments.md | 10 +++---- docs/tutorials/sharing-environments.md | 10 +++---- mkdocs.yml | 7 +++-- 27 files changed, 120 insertions(+), 121 deletions(-) diff --git a/.flox/env/manifest.toml b/.flox/env/manifest.toml index 9a7fc78b..e67dc742 100644 --- a/.flox/env/manifest.toml +++ b/.flox/env/manifest.toml @@ -52,7 +52,7 @@ if [ ! -d "$FLOX_SRC_DIR" ]; then fi echo "4. πŸ‘‰ Extracted Flox source archive" -export FLOX_MAN_PAGES_DIR="$PWD/docs/reference/command-reference" +export FLOX_MAN_PAGES_DIR="$PWD/docs/manual" if [ -d "$FLOX_MAN_PAGES_DIR" ]; then rm -rf "$FLOX_MAN_PAGES_DIR/*" fi diff --git a/.gitignore b/.gitignore index 6ea01ce7..8dac0a1a 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,7 @@ .direnv/ site/ include/ -docs/reference/command-reference +docs/manual result result-* bin/ diff --git a/docs/concepts/activation.md b/docs/concepts/activation.md index c0b26f03..194e4dd6 100644 --- a/docs/concepts/activation.md +++ b/docs/concepts/activation.md @@ -310,7 +310,7 @@ attach to this new version of the environment. ## Development vs. runtime mode -See the [`options.activate.mode`](../reference/command-reference/manifest.toml.md#options) option in the manifest. +See the [`options.activate.mode`](../manual/manifest.toml.md#options) option in the manifest. ## Conclusion @@ -329,6 +329,6 @@ that prepare your environment just how you like them. [environment-concept]: ./services.md [bash-func-export]: https://www.gnu.org/software/bash/manual/html_node/Bourne-Shell-Builtins.html#index-export -[vars-section]: ../reference/command-reference/manifest.toml.md#vars -[hook-section]: ../reference/command-reference/manifest.toml.md#hook -[profile-section]: ../reference/command-reference/manifest.toml.md#profile +[vars-section]: ../manual/manifest.toml.md#vars +[hook-section]: ../manual/manifest.toml.md#hook +[profile-section]: ../manual/manifest.toml.md#profile diff --git a/docs/concepts/builds.md b/docs/concepts/builds.md index 5af89062..c5183fe3 100644 --- a/docs/concepts/builds.md +++ b/docs/concepts/builds.md @@ -42,5 +42,5 @@ One way to accomplish this is to run your builds in [CI][flox-ci-cd]. [manifest-builds-concept]: ./manifest-builds.md [nix-expression-builds-concept]: ./nix-expression-builds.md -[flox-build]: ../reference/command-reference/flox-build.md +[flox-build]: ../manual/flox-build.md [flox-ci-cd]: ../tutorials/ci-cd.md diff --git a/docs/concepts/environments.md b/docs/concepts/environments.md index e9e99acc..b91eff82 100644 --- a/docs/concepts/environments.md +++ b/docs/concepts/environments.md @@ -110,21 +110,21 @@ version. Flox manages this file for you. } ``` -[flox_init]: ../reference/command-reference/flox-init.md -[flox_show]: ../reference/command-reference/flox-show.md -[flox_edit]: ../reference/command-reference/flox-edit.md -[flox_install]: ../reference/command-reference/flox-install.md -[flox_search]: ../reference/command-reference/flox-search.md -[flox_edit]: ../reference/command-reference/flox-edit.md -[flox_push]: ../reference/command-reference/flox-push.md -[flox_pull]: ../reference/command-reference/flox-pull.md -[flox_activate]: ../reference/command-reference/flox-activate.md +[flox_init]: ../manual/flox-init.md +[flox_show]: ../manual/flox-show.md +[flox_edit]: ../manual/flox-edit.md +[flox_install]: ../manual/flox-install.md +[flox_search]: ../manual/flox-search.md +[flox_edit]: ../manual/flox-edit.md +[flox_push]: ../manual/flox-push.md +[flox_pull]: ../manual/flox-pull.md +[flox_activate]: ../manual/flox-activate.md [sharing_guide]: ../tutorials/sharing-environments.md [create_guide]: ../tutorials/creating-environments.md [customizing_environments_guide]: ../tutorials/customizing-environments.md [generation_concept]: ./generations.md [floxhub_concept]: ./floxhub.md [discourse]: https://discourse.flox.dev/ -[manifest]: ../reference/command-reference/manifest.toml.md +[manifest]: ../manual/manifest.toml.md [nix-expression-builds-concept]: ./nix-expression-builds.md [toml_spec]: https://toml.io/en/v1.0.0 diff --git a/docs/concepts/flox-vs-containers.md b/docs/concepts/flox-vs-containers.md index 8d0379b1..26712c29 100644 --- a/docs/concepts/flox-vs-containers.md +++ b/docs/concepts/flox-vs-containers.md @@ -439,13 +439,13 @@ you need to build a container so that it can be deployed. --- -[init]: ../reference/command-reference/flox-init.md -[edit]: ../reference/command-reference/flox-edit.md -[install]: ../reference/command-reference/flox-install.md -[push]: ../reference/command-reference/flox-push.md -[containerize]: ../reference/command-reference/flox-containerize.md -[activate]: ../reference/command-reference/flox-activate.md -[services-start]: ../reference/command-reference/flox-services-start.md +[init]: ../manual/flox-init.md +[edit]: ../manual/flox-edit.md +[install]: ../manual/flox-install.md +[push]: ../manual/flox-push.md +[containerize]: ../manual/flox-containerize.md +[activate]: ../manual/flox-activate.md +[services-start]: ../manual/flox-services-start.md [services]: ../concepts/services.md [manifest]: ../concepts/environments.md#manifesttoml [early]: https://flox.dev/early/ diff --git a/docs/concepts/floxhub.md b/docs/concepts/floxhub.md index 948a3f8a..65de3056 100644 --- a/docs/concepts/floxhub.md +++ b/docs/concepts/floxhub.md @@ -97,13 +97,13 @@ flox pull example-owner/example-env Run the [`flox auth logout`][flox_auth] command. [flox_website]: https://flox.dev -[flox_push]: ../reference/command-reference/flox-push.md -[flox_pull]: ../reference/command-reference/flox-pull.md -[flox_activate]: ../reference/command-reference/flox-activate.md -[flox_auth]: ../reference/command-reference/flox-auth.md -[flox_edit]: ../reference/command-reference/flox-edit.md -[flox_install]: ../reference/command-reference/flox-install.md -[flox_uninstall]: ../reference/command-reference/flox-uninstall.md +[flox_push]: ../manual/flox-push.md +[flox_pull]: ../manual/flox-pull.md +[flox_activate]: ../manual/flox-activate.md +[flox_auth]: ../manual/flox-auth.md +[flox_edit]: ../manual/flox-edit.md +[flox_install]: ../manual/flox-install.md +[flox_uninstall]: ../manual/flox-uninstall.md [generation_concept]: ../concepts/generations.md [manifest_concept]: ../concepts/environments.md#manifesttoml [environments_concept]: ../concepts/environments.md diff --git a/docs/concepts/generations.md b/docs/concepts/generations.md index 6209e147..f983676b 100644 --- a/docs/concepts/generations.md +++ b/docs/concepts/generations.md @@ -79,9 +79,9 @@ This allows this environment to advance to newer generations explicitly on the next [`flox pull`][flox_pull]. [floxhub_concept]: .//floxhub.md -[flox_push]: ../reference/command-reference/flox-push.md -[flox_install]: ../reference/command-reference/flox-install.md -[flox_edit]: ../reference/command-reference/flox-edit.md -[flox_pull]: ../reference/command-reference/flox-pull.md +[flox_push]: ../manual/flox-push.md +[flox_install]: ../manual/flox-install.md +[flox_edit]: ../manual/flox-edit.md +[flox_pull]: ../manual/flox-pull.md [sharing_guide]: ../tutorials/sharing-environments.md [environment_guide]: ../tutorials/creating-environments.md diff --git a/docs/concepts/manifest-builds.md b/docs/concepts/manifest-builds.md index e9e95fec..4dbb1582 100644 --- a/docs/concepts/manifest-builds.md +++ b/docs/concepts/manifest-builds.md @@ -190,11 +190,11 @@ Each language guide in the Languages section of the Cookbook contains an example For example, [this section][go-example] contains an example build for the Go language. [builds-concept]: ./builds.md -[manifest-reference]: ../reference/command-reference/manifest.toml.md#build +[manifest-reference]: ../manual/manifest.toml.md#build [services-concept]: ./services.md [publish-concept]: ./publishing.md [fhs-docs]: https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard -[pkg-groups]: ../reference/command-reference/manifest.toml.md#package-descriptors +[pkg-groups]: ../manual/manifest.toml.md#package-descriptors [grpc]: https://grpc.io/ [organizations-concept]: ./organizations.md [go-example]: ../languages/go.md#build-with-flox diff --git a/docs/concepts/nix-expression-builds.md b/docs/concepts/nix-expression-builds.md index 80820f10..1c9e3553 100644 --- a/docs/concepts/nix-expression-builds.md +++ b/docs/concepts/nix-expression-builds.md @@ -242,4 +242,4 @@ error: hash mismatch in fixed-output derivation '/nix/store/srm7s6pyckifs52ikyfa [builds-concept]: ./builds.md [manifest-builds-concept]: ./manifest-builds.md -[pkg-groups]: ../reference/command-reference/manifest.toml.md#package-descriptors +[pkg-groups]: ../manual/manifest.toml.md#package-descriptors diff --git a/docs/concepts/packages-and-catalog.md b/docs/concepts/packages-and-catalog.md index 8640c59a..5e78c6aa 100644 --- a/docs/concepts/packages-and-catalog.md +++ b/docs/concepts/packages-and-catalog.md @@ -38,10 +38,10 @@ Source by the Open Source Initiative (OSI). * **broken**: indicates if the package is marked as broken in [nixpkgs][nixpkgs]. -[flox_search]: ../reference/command-reference/flox-search.md -[flox_show]: ../reference/command-reference/flox-show.md -[flox_install]: ../reference/command-reference/flox-install.md -[flox_update]: ../reference/command-reference/flox-update.md +[flox_search]: ../manual/flox-search.md +[flox_show]: ../manual/flox-show.md +[flox_install]: ../manual/flox-install.md +[flox_update]: ../manual/flox-update.md [manifest_concept]: ./environments.md#manifesttoml [nixpkgs]: https://github.com/NixOS/nixpkgs [builds]: ./builds.md diff --git a/docs/concepts/publishing.md b/docs/concepts/publishing.md index f2de7a9c..ce1bcd84 100644 --- a/docs/concepts/publishing.md +++ b/docs/concepts/publishing.md @@ -83,9 +83,9 @@ For anyone in the organization, published packages become available in [builds-concept]: ./builds.md [catalog-concept]: ./packages-and-catalog.md -[flox-build]: ../reference/command-reference/flox-build.md -[flox-publish]: ../reference/command-reference/flox-publish.md -[flox-search]: ../reference/command-reference/flox-search.md -[flox-show]: ../reference/command-reference/flox-show.md -[flox-install]: ../reference/command-reference/flox-install.md +[flox-build]: ../manual/flox-build.md +[flox-publish]: ../manual/flox-publish.md +[flox-search]: ../manual/flox-search.md +[flox-show]: ../manual/flox-show.md +[flox-install]: ../manual/flox-install.md [organizations-concept]: ./organizations.md diff --git a/docs/concepts/services.md b/docs/concepts/services.md index f627063c..b8d96254 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -28,7 +28,7 @@ Services have a very simple schema consisting of a `command` to run to start the service, any `vars` you want set specifically for the service, and whether the service spawns a background process. -See [`manifest-toml(1)`](../reference/command-reference/manifest.toml.md) for +See [`manifest-toml(1)`](../manual/manifest.toml.md) for more details on the exact format of the `[services]` section of the manfiest. An example service definition is shown below: diff --git a/docs/flox-5-minutes.md b/docs/flox-5-minutes.md index 6e0fe7ab..699ff628 100644 --- a/docs/flox-5-minutes.md +++ b/docs/flox-5-minutes.md @@ -252,23 +252,23 @@ There are _so_ many things we didn't have time to cover, so here's some addition [install_flox]: ./install-flox/install.md [create_guide]: ./tutorials/creating-environments.md [sharing]: ./tutorials/sharing-environments.md -[init]: ./reference/command-reference/flox-init.md -[search]: ./reference/command-reference/flox-search.md -[show]: ./reference/command-reference/flox-show.md +[init]: ./manual/flox-init.md +[search]: ./manual/flox-search.md +[show]: ./manual/flox-show.md [catalog]: ./concepts/packages-and-catalog.md -[install]: ./reference/command-reference/flox-install.md -[activate]: ./reference/command-reference/flox-activate.md -[edit]: ./reference/command-reference/flox-edit.md -[push]: ./reference/command-reference/flox-push.md -[list]: ./reference/command-reference/flox-list.md -[manifest]: ./reference/command-reference/manifest.toml.md +[install]: ./manual/flox-install.md +[activate]: ./manual/flox-activate.md +[edit]: ./manual/flox-edit.md +[push]: ./manual/flox-push.md +[list]: ./manual/flox-list.md +[manifest]: ./manual/manifest.toml.md [multi-arch]: ./tutorials/multi-arch-environments.md [services]: ./concepts/services.md [bun]: https://bun.sh/ [zig]: https://ziglang.org/ [floxhub]: https://hub.flox.dev [sleep-issue]: https://github.com/flox/flox/pull/1931 -[install-section]: ./reference/command-reference/manifest.toml.md#install +[install-section]: ./manual/manifest.toml.md#install [activation-tutorial]: ./tutorials/customizing-environments.md [ci]: ./tutorials/ci-cd.md [composition]: ./tutorials/composition.md diff --git a/docs/index.md b/docs/index.md index 5bd18fbb..65e8782a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -108,7 +108,7 @@ If you're already using Homebrew, you can easily [migrate or use Homebrew and Fl Flox lets you define what an environment _is_ in a way that can be reused across local dev, CI, and production. Leverage [pre-built integrations](https://flox.dev/docs/tutorials/ci-cd/?h=ci) for GitHub Actions, CircleCI, and GitLab to pull and activate the same environments locally, in CI and in production. -Or use Flox [containerize](https://flox.dev/docs/reference/command-reference/flox-containerize/?h=containerize) to package your environments as OCI imagesβ€”fully pinned and runnable anywhere. +Or use Flox [containerize](https://flox.dev/docs/manual/flox-containerize/?h=containerize) to package your environments as OCI imagesβ€”fully pinned and runnable anywhere. From bare metal to VMs, from Docker Swarm to Kubernetes to AWS Lambdaβ€”the runtime context might change, but Flox environments run and behave the same everywhere. Need an example? See how [the Flox Docs team uses Flox in CI](https://flox.dev/blog/integrating-flox-with-ci-for-consistent-reproducible-dev-environments/) to build, test and deploy this docs site. @@ -131,20 +131,20 @@ The Flox product and engineering teams love to hear directly from users. Your qu [flox_5_minutes]: ./flox-5-minutes.md [create_guide]: ./tutorials/creating-environments.md [share_guide]: ./tutorials/sharing-environments.md -[init]: ./reference/command-reference/flox-init.md -[search]: ./reference/command-reference/flox-search.md -[show]: ./reference/command-reference/flox-show.md +[init]: ./manual/flox-init.md +[search]: ./manual/flox-search.md +[show]: ./manual/flox-show.md [catalog]: ./concepts/packages-and-catalog.md -[install]: ./reference/command-reference/flox-install.md -[activate]: ./reference/command-reference/flox-activate.md -[edit]: ./reference/command-reference/flox-edit.md -[push]: ./reference/command-reference/flox-push.md -[pull]: ./reference/command-reference/flox-pull.md -[delete]: ./reference/command-reference/flox-delete.md -[list]: ./reference/command-reference/flox-list.md -[manifest]: ./reference/command-reference/manifest.toml.md +[install]: ./manual/flox-install.md +[activate]: ./manual/flox-activate.md +[edit]: ./manual/flox-edit.md +[push]: ./manual/flox-push.md +[pull]: ./manual/flox-pull.md +[delete]: ./manual/flox-delete.md +[list]: ./manual/flox-list.md +[manifest]: ./manual/manifest.toml.md [rust-cookbook]: ./languages/rust.md [multi-arch]: ./tutorials/multi-arch-environments.md -[config]: ./reference/command-reference/flox-config.md +[config]: ./manual/flox-config.md [services]: ./concepts/services.md [floxhub_packages]: https://hub.flox.dev/packages diff --git a/docs/tutorials/build-and-publish.md b/docs/tutorials/build-and-publish.md index 606d6556..57355a55 100644 --- a/docs/tutorials/build-and-publish.md +++ b/docs/tutorials/build-and-publish.md @@ -256,15 +256,15 @@ The story doesn't end here though. In this guide we've shown you how to build and distribute programs, but you can also use it to distribute configuration files (or any other file). See the [builds][extra-builds] concept page for examples of what else you can build and publish with Flox. -[flox-manifest-build-section]: ../reference/command-reference/manifest.toml.md#build +[flox-manifest-build-section]: ../manual/manifest.toml.md#build [build-concept]: ../concepts/builds.md [fhs]: https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard -[flox-install]: ../reference/command-reference/flox-install.md -[flox-show]: ../reference/command-reference/flox-show.md -[flox-search]: ../reference/command-reference/flox-search.md -[flox-edit]: ../reference/command-reference/flox-edit.md -[flox-build]: ../reference/command-reference/flox-build.md -[flox-publish]: ../reference/command-reference/flox-publish.md +[flox-install]: ../manual/flox-install.md +[flox-show]: ../manual/flox-show.md +[flox-search]: ../manual/flox-search.md +[flox-edit]: ../manual/flox-edit.md +[flox-build]: ../manual/flox-build.md +[flox-publish]: ../manual/flox-publish.md [extra-builds]: ../concepts/manifest-builds.md#example-configuration-files [publish-concept]: ../concepts/publishing.md [organizations-concept]: ../concepts/organizations.md diff --git a/docs/tutorials/ci-cd.md b/docs/tutorials/ci-cd.md index b40200c3..9e9e3899 100644 --- a/docs/tutorials/ci-cd.md +++ b/docs/tutorials/ci-cd.md @@ -121,4 +121,4 @@ Here are some suggestions for things you can do with your Flox environment in CI [sharing_guide]: ./sharing-environments.md [layering_guide]: ./layering-multiple-environments.md [customizing_guide]: ./customizing-environments.md -[containerize]: ../reference/command-reference/flox-containerize.md +[containerize]: ../manual/flox-containerize.md diff --git a/docs/tutorials/composition.md b/docs/tutorials/composition.md index f6280642..2267c72b 100644 --- a/docs/tutorials/composition.md +++ b/docs/tutorials/composition.md @@ -297,10 +297,10 @@ This means you can spend less time getting started, and more time developing you Similarly, since you're treating environments like dependencies, if you make an improvement to a template environment while working on one project, the improvement will become available to all of your other projects that use that environment as soon as they run `flox include upgrade`. [poetry]: https://python-poetry.org/ -[flox-init]: ../reference/command-reference/flox-init.md -[flox-pull]: ../reference/command-reference/flox-pull.md -[flox-install]: ../reference/command-reference/flox-install.md -[flox-edit]: ../reference/command-reference/flox-edit.md -[flox-list]: ../reference/command-reference/flox-list.md +[flox-init]: ../manual/flox-init.md +[flox-pull]: ../manual/flox-pull.md +[flox-install]: ../manual/flox-install.md +[flox-edit]: ../manual/flox-edit.md +[flox-list]: ../manual/flox-list.md [floxhub]: ../concepts/floxhub.md [hypothesis]: https://hypothesis.readthedocs.io/en/latest/ diff --git a/docs/tutorials/creating-environments.md b/docs/tutorials/creating-environments.md index a67a2e65..49053113 100644 --- a/docs/tutorials/creating-environments.md +++ b/docs/tutorials/creating-environments.md @@ -228,13 +228,13 @@ flox [example-project] $ exit $ ``` -[flox_init]: ../reference/command-reference/flox-init.md -[flox_search]: ../reference/command-reference/flox-search.md -[flox_show]: ../reference/command-reference/flox-show.md -[flox_install]: ../reference/command-reference/flox-install.md +[flox_init]: ../manual/flox-init.md +[flox_search]: ../manual/flox-search.md +[flox_show]: ../manual/flox-show.md +[flox_install]: ../manual/flox-install.md [discourse]: https://discourse.floxdev.com/ -[flox_activate]: ../reference/command-reference/flox-activate.md -[flox_edit]: ../reference/command-reference/flox-edit.md +[flox_activate]: ../manual/flox-activate.md +[flox_edit]: ../manual/flox-edit.md [sharing_guide]: ./sharing-environments.md [layering_guide]: ./layering-multiple-environments.md [manifest_concept]: ../concepts/environments.md#manifesttoml diff --git a/docs/tutorials/customizing-environments.md b/docs/tutorials/customizing-environments.md index cab3b597..6434146e 100644 --- a/docs/tutorials/customizing-environments.md +++ b/docs/tutorials/customizing-environments.md @@ -174,10 +174,10 @@ mycli - :simple-readme:{ .flox-purple .flox-heart } [Multiple architecture environments][multi-arch-guide] [environment_concept]: ../concepts/environments.md -[flox_activate]: ../reference/command-reference/flox-activate.md +[flox_activate]: ../manual/flox-activate.md [multi-arch-guide]: ./multi-arch-environments.md [rust_guide]: ../languages/rust.md -[flox_init]: ../reference/command-reference/flox-init.md +[flox_init]: ../manual/flox-init.md [activation_concept]: ../concepts/activation.md [fish_shell]: https://fishshell.com/ -[flox_install]: ../reference/command-reference/flox-install.md +[flox_install]: ../manual/flox-install.md diff --git a/docs/tutorials/default-environment.md b/docs/tutorials/default-environment.md index 3e8285d0..4a898ccd 100644 --- a/docs/tutorials/default-environment.md +++ b/docs/tutorials/default-environment.md @@ -247,6 +247,6 @@ Flox has you covered. Even better, if you want both a package manager _and_ developer environments, with Flox you only need to learn one tool. -[init]: ../reference/command-reference/flox-init.md -[push]: ../reference/command-reference/flox-push.md -[pull]: ../reference/command-reference/flox-pull.md +[init]: ../manual/flox-init.md +[push]: ../manual/flox-push.md +[pull]: ../manual/flox-pull.md diff --git a/docs/tutorials/layering-multiple-environments.md b/docs/tutorials/layering-multiple-environments.md index 25d7377f..266400f7 100644 --- a/docs/tutorials/layering-multiple-environments.md +++ b/docs/tutorials/layering-multiple-environments.md @@ -127,10 +127,10 @@ Inactive environments: - :simple-readme:{ .flox-purple .flox-heart } [Designing multiple architecture environments][multi_arch_guide] [default-env]: ./default-environment.md -[flox_init]: ../reference/command-reference/flox-init.md -[flox_install]: ../reference/command-reference/flox-install.md -[flox_activate]: ../reference/command-reference/flox-activate.md -[flox_list]: ../reference/command-reference/flox-list.md +[flox_init]: ../manual/flox-init.md +[flox_install]: ../manual/flox-install.md +[flox_activate]: ../manual/flox-activate.md +[flox_list]: ../manual/flox-list.md [sharing_guide]: ./sharing-environments.md [customizing_guide]: ./customizing-environments.md [multi_arch_guide]: ./multi-arch-environments.md diff --git a/docs/tutorials/migrations/homebrew.md b/docs/tutorials/migrations/homebrew.md index eb772a58..6382ebef 100644 --- a/docs/tutorials/migrations/homebrew.md +++ b/docs/tutorials/migrations/homebrew.md @@ -202,10 +202,10 @@ We recommend that the Flox default environment activation lines appear lowest in [default_tutorial_setup]: ../default-environment.md#initial-setup [creating_tutorial]: ../creating-environments.md [install_flox]: ../../install-flox/install.md -[search]: ../../reference/command-reference/flox-search.md -[envs]: ../../reference/command-reference/flox-envs.md -[list]: ../../reference/command-reference/flox-list.md +[search]: ../../manual/flox-search.md +[envs]: ../../manual/flox-envs.md +[list]: ../../manual/flox-list.md [catalog]: ../../concepts/packages-and-catalog.md -[install]: ../../reference/command-reference/flox-install.md -[uninstall]: ../../reference/command-reference/flox-uninstall.md -[activate]: ../../reference/command-reference/flox-activate.md +[install]: ../../manual/flox-install.md +[uninstall]: ../../manual/flox-uninstall.md +[activate]: ../../manual/flox-activate.md diff --git a/docs/tutorials/migrations/nvm.md b/docs/tutorials/migrations/nvm.md index f71b7a34..92a9ec33 100644 --- a/docs/tutorials/migrations/nvm.md +++ b/docs/tutorials/migrations/nvm.md @@ -189,5 +189,5 @@ Now that you're managing your project's Node.js version using Flox, you can `git [environment_concept]: ../../concepts/environments.md [install_flox]: ../../install-flox/install.md -[manifest]: ../../reference/command-reference/manifest.toml.md +[manifest]: ../../manual/manifest.toml.md [services]: ../../concepts/services.md diff --git a/docs/tutorials/multi-arch-environments.md b/docs/tutorials/multi-arch-environments.md index 41c92525..59f40e2d 100644 --- a/docs/tutorials/multi-arch-environments.md +++ b/docs/tutorials/multi-arch-environments.md @@ -138,8 +138,8 @@ get the `systemd` package. [environment_concept]: ../concepts/environments.md [sharing_guide]: ./sharing-environments.md -[flox_search]: ../reference/command-reference/flox-search.md -[flox_show]: ../reference/command-reference/flox-show.md -[flox_edit]: ../reference/command-reference/flox-edit.md -[flox_push]: ../reference/command-reference/flox-push.md -[flox_pull]: ../reference/command-reference/flox-pull.md +[flox_search]: ../manual/flox-search.md +[flox_show]: ../manual/flox-show.md +[flox_edit]: ../manual/flox-edit.md +[flox_push]: ../manual/flox-push.md +[flox_pull]: ../manual/flox-pull.md diff --git a/docs/tutorials/sharing-environments.md b/docs/tutorials/sharing-environments.md index b5c0a337..1a7e0cc6 100644 --- a/docs/tutorials/sharing-environments.md +++ b/docs/tutorials/sharing-environments.md @@ -54,7 +54,7 @@ git clone ..example-project; flox activate ``` -[flox_init]: ../reference/command-reference/flox-init.md +[flox_init]: ../manual/flox-init.md [discourse]: https://discourse.flox.dev/ [manifest_concept]: ../concepts/environments.md#manifesttoml @@ -128,9 +128,9 @@ $ flox push !!! note "Note" Right now, only environment owners can push edits to their environments. -[flox_push]: ../reference/command-reference/flox-push.md -[flox_pull]: ../reference/command-reference/flox-pull.md -[flox_activate]: ../reference/command-reference/flox-activate.md +[flox_push]: ../manual/flox-push.md +[flox_pull]: ../manual/flox-pull.md +[flox_activate]: ../manual/flox-activate.md [floxhub_concept]: ../concepts/floxhub.md ### Pulling a remote environment without connecting to FloxHub @@ -228,4 +228,4 @@ telnet (GNU inetutils) 2.5 [environment_concept]: ../concepts/environments.md [layering_guide]: ./layering-multiple-environments.md [customizing_guide]: ./customizing-environments.md -[flox_containerize]: ../reference/command-reference/flox-containerize.md +[flox_containerize]: ../manual/flox-containerize.md diff --git a/mkdocs.yml b/mkdocs.yml index f90c4755..5104b566 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,10 +67,9 @@ nav: - Flox vs. container workflows: concepts/flox-vs-containers.md - Languages: - ... | flat | languages/* - - Reference: - - Flox manual: - - reference/command-reference/flox.md - - ... | flat | reference/command-reference/* + - Manual: + - manual/flox.md + - ... | flat | manual/* strict: true validation: From f44238a9d716962dc4b830a861bb66d9fbfe0017 Mon Sep 17 00:00:00 2001 From: Daniel Sauble Date: Wed, 1 Oct 2025 13:11:08 -0700 Subject: [PATCH 3/7] Revert unnecessary formatting of mkdocs.yml --- mkdocs.yml | 498 +++++++++++++++++++++++++++-------------------------- 1 file changed, 250 insertions(+), 248 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 5104b566..0bb79e2f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,7 +25,7 @@ repo_url: "https://github.com/flox/flox" copyright: "Copyright 2025 Flox. All rights reserved." extra: - FLOX_VERSION: !ENV [FLOX_VERSION, "X.Y.Z"] + FLOX_VERSION: !ENV [FLOX_VERSION, 'X.Y.Z'] FLOX_PUBLIC_KEY: "flox-cache-public-1:7F4OyH7ZCnFhcze3fJdfyXYLQw/aV7GEed86nQ7IsOs=" generator: false analytics: @@ -34,42 +34,42 @@ extra: nav: - Introduction: index.md - Install Flox: - - Install: install-flox/install.md - - Uninstall: install-flox/uninstall.md + - Install: install-flox/install.md + - Uninstall: install-flox/uninstall.md - Flox in 5 minutes: flox-5-minutes.md - Tutorials: - - Creating environments: tutorials/creating-environments.md - - The default environment: tutorials/default-environment.md - - Sharing environments: tutorials/sharing-environments.md - - Layering multiple environments: tutorials/layering-multiple-environments.md - - Customizing the shell environment: tutorials/customizing-environments.md - - Designing multi-arch environments: tutorials/multi-arch-environments.md - - Building and publishing packages: tutorials/build-and-publish.md - - Running Flox in CI/CD: tutorials/ci-cd.md - - Designing cross-platform environments: tutorials/multi-arch-environments.md - - Reusing and combining developer environments: tutorials/composition.md - - Flox + CUDA: tutorials/cuda.md - - Migration guides: - - ... | flat | tutorials/migrations/* + - Creating environments: tutorials/creating-environments.md + - The default environment: tutorials/default-environment.md + - Sharing environments: tutorials/sharing-environments.md + - Layering multiple environments: tutorials/layering-multiple-environments.md + - Customizing the shell environment: tutorials/customizing-environments.md + - Designing multi-arch environments: tutorials/multi-arch-environments.md + - Building and publishing packages: tutorials/build-and-publish.md + - Running Flox in CI/CD: tutorials/ci-cd.md + - Designing cross-platform environments: tutorials/multi-arch-environments.md + - Reusing and combining developer environments: tutorials/composition.md + - Flox + CUDA: tutorials/cuda.md + - Migration guides: + - ... | flat | tutorials/migrations/* - Concepts: - - Environments: concepts/environments.md - - Activating environments: concepts/activation.md - - FloxHub: concepts/floxhub.md - - Generations: concepts/generations.md - - Catalog and Packages: concepts/packages-and-catalog.md - - Services: concepts/services.md - - Composing environments: concepts/composition.md - - Organizations: concepts/organizations.md - - Builds: concepts/builds.md - - Manifest builds: concepts/manifest-builds.md - - Nix expression builds: concepts/nix-expression-builds.md - - Publishing: concepts/publishing.md - - Flox vs. container workflows: concepts/flox-vs-containers.md + - Environments: concepts/environments.md + - Activating environments: concepts/activation.md + - FloxHub: concepts/floxhub.md + - Generations: concepts/generations.md + - Catalog and Packages: concepts/packages-and-catalog.md + - Services: concepts/services.md + - Composing environments: concepts/composition.md + - Organizations: concepts/organizations.md + - Builds: concepts/builds.md + - Manifest builds: concepts/manifest-builds.md + - Nix expression builds: concepts/nix-expression-builds.md + - Publishing: concepts/publishing.md + - Flox vs. container workflows: concepts/flox-vs-containers.md - Languages: - - ... | flat | languages/* + - ... | flat | languages/* - Manual: - - manual/flox.md - - ... | flat | manual/* + - manual/flox.md + - ... | flat | manual/* strict: true validation: @@ -86,223 +86,225 @@ extra_css: - css/extra.css theme: - name: material - - custom_dir: overrides - - language: en - direction: ltr - - favicon: img/favicon.ico - logo: img/logo.svg - - font: false - - palette: - # Palette toggle for light mode - - media: "(prefers-color-scheme: light)" - scheme: default - primary: custom - accent: custom - toggle: - icon: material/brightness-7 - name: Switch to dark mode - - # Palette toggle for dark mode - - media: "(prefers-color-scheme: dark)" - scheme: slate - primary: custom - accent: custom - toggle: - icon: material/brightness-4 - name: Switch to light mode - - icon: - # Repository icon - # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-icon - repo: fontawesome/brands/github - - # Admonition icons - # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonition-icons - admonition: - announce: material/bullhorn - - features: - # Clicks on all internal links will be intercepted and dispatched via - # XHR without fully reloading the page. - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading - - navigation.instant # Instant loading - - navigation.instant.prefetch # Instant prefetching - - navigation.instant.progress # Progress indicator - - navigation.tracking # Anchor tracking - # - navigation.tabs # Navigation tabs - # - navigation.sections # Navigation sections - - navigation.expand # Navigation expansion - - navigation.path # Navigation path aka Breadcrumbs - - navigation.prune # Navigation pruning - # - navigation.indexes # Section index pages - - navigation.top # Back-to-top button - - toc.follow # Anchor following - # - toc.integrate # Navigation integration - - navigation.footer - - # The search will display the likeliest completion for the last word - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions - - search.suggest - - search.highlight - - search.share - - # Code blocks - # - content.code.copy # Enable copy button on a case-by-case basis - # See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button - - content.code.select # Code selection button - # See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations - - content.code.annotate # Code annotations - - # Footnote tooltips - # https://squidfunk.github.io/mkdocs-material/reference/footnotes/#footnote-tooltips - - content.footnote.tooltips - - # Improved tooltips - # https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips - - content.tooltips + name: material + + custom_dir: overrides + + language: en + direction: ltr + + favicon: img/favicon.ico + logo: img/logo.svg + + font: false + + palette: + + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + primary: custom + accent: custom + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: custom + accent: custom + toggle: + icon: material/brightness-4 + name: Switch to light mode + + icon: + # Repository icon + # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#repository-icon + repo: fontawesome/brands/github + + # Admonition icons + # https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonition-icons + admonition: + announce: material/bullhorn + + features: + # Clicks on all internal links will be intercepted and dispatched via + # XHR without fully reloading the page. + # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#instant-loading + - navigation.instant # Instant loading + - navigation.instant.prefetch # Instant prefetching + - navigation.instant.progress # Progress indicator + - navigation.tracking # Anchor tracking + # - navigation.tabs # Navigation tabs + # - navigation.sections # Navigation sections + - navigation.expand # Navigation expansion + - navigation.path # Navigation path aka Breadcrumbs + - navigation.prune # Navigation pruning + # - navigation.indexes # Section index pages + - navigation.top # Back-to-top button + - toc.follow # Anchor following + # - toc.integrate # Navigation integration + - navigation.footer + + # The search will display the likeliest completion for the last word + # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions + - search.suggest + - search.highlight + - search.share + + # Code blocks + # - content.code.copy # Enable copy button on a case-by-case basis + # See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-selection-button + - content.code.select # Code selection button + # See https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations + - content.code.annotate # Code annotations + + # Footnote tooltips + # https://squidfunk.github.io/mkdocs-material/reference/footnotes/#footnote-tooltips + - content.footnote.tooltips + + # Improved tooltips + # https://squidfunk.github.io/mkdocs-material/reference/tooltips/#improved-tooltips + - content.tooltips markdown_extensions: - # Admonitions - # https://squidfunk.github.io/mkdocs-material/reference/admonitions/ - - admonition - - pymdownx.details - - pymdownx.superfences - - # Annotations - # https://squidfunk.github.io/mkdocs-material/reference/annotations/ - - attr_list - - md_in_html - - pymdownx.superfences - - # Buttons - # https://squidfunk.github.io/mkdocs-material/reference/buttons/ - - attr_list - - # Code blocks - # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/ - - pymdownx.highlight: - anchor_linenums: true - line_spans: __span - pygments_lang_class: true - - pymdownx.inlinehilite - - pymdownx.snippets: - base_path: "docs/snippets" - - pymdownx.superfences - - # Content tabs - # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/ - - pymdownx.superfences - - pymdownx.tabbed: - alternate_style: true - - # Data tables - # https://squidfunk.github.io/mkdocs-material/reference/data-tables/ - - tables - - # Diagrams - # https://squidfunk.github.io/mkdocs-material/reference/diagrams/ - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format - # Footnotes - # https://squidfunk.github.io/mkdocs-material/reference/footnotes/ - - - footnotes - - # Formatting - # https://squidfunk.github.io/mkdocs-material/reference/formatting/ - - pymdownx.critic - - pymdownx.caret - - pymdownx.keys - - pymdownx.mark - - pymdownx.tilde - - # Grids - # https://squidfunk.github.io/mkdocs-material/reference/grids/ - - attr_list - - md_in_html - - # Icons, Emojis - # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/ - - attr_list - - pymdownx.emoji: - emoji_index: !!python/name:material.extensions.emoji.twemoji - emoji_generator: !!python/name:material.extensions.emoji.to_svg - # Images - # https://squidfunk.github.io/mkdocs-material/reference/images/ - - - attr_list - - md_in_html - - # Lists - # https://squidfunk.github.io/mkdocs-material/reference/lists/ - - def_list - - pymdownx.tasklist: - custom_checkbox: true - - # Tooltips - # https://squidfunk.github.io/mkdocs-material/reference/tooltips/ - - abbr - - attr_list - - pymdownx.snippets + # Admonitions + # https://squidfunk.github.io/mkdocs-material/reference/admonitions/ + - admonition + - pymdownx.details + - pymdownx.superfences + + # Annotations + # https://squidfunk.github.io/mkdocs-material/reference/annotations/ + - attr_list + - md_in_html + - pymdownx.superfences + + # Buttons + # https://squidfunk.github.io/mkdocs-material/reference/buttons/ + - attr_list + + # Code blocks + # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/ + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets: + base_path: "docs/snippets" + - pymdownx.superfences + + # Content tabs + # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/ + - pymdownx.superfences + - pymdownx.tabbed: + alternate_style: true + + # Data tables + # https://squidfunk.github.io/mkdocs-material/reference/data-tables/ + - tables + + # Diagrams + # https://squidfunk.github.io/mkdocs-material/reference/diagrams/ + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + + # Footnotes + # https://squidfunk.github.io/mkdocs-material/reference/footnotes/ + - footnotes + + # Formatting + # https://squidfunk.github.io/mkdocs-material/reference/formatting/ + - pymdownx.critic + - pymdownx.caret + - pymdownx.keys + - pymdownx.mark + - pymdownx.tilde + + # Grids + # https://squidfunk.github.io/mkdocs-material/reference/grids/ + - attr_list + - md_in_html + + # Icons, Emojis + # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/ + - attr_list + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + + # Images + # https://squidfunk.github.io/mkdocs-material/reference/images/ + - attr_list + - md_in_html + + # Lists + # https://squidfunk.github.io/mkdocs-material/reference/lists/ + - def_list + - pymdownx.tasklist: + custom_checkbox: true + + # Tooltips + # https://squidfunk.github.io/mkdocs-material/reference/tooltips/ + - abbr + - attr_list + - pymdownx.snippets plugins: - # Excellent client-side search implementation, omitting the need for the - # integration of third-party services - # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin - - search - - # The built-in optimize plugin automatically identifies and optimizes all - # media files as part of the build using compression and conversion - # techniques. - # https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin - - optimize - - # Lightbox - image zoom - # https://github.com/blueswen/mkdocs-glightbox - - glightbox: - touchNavigation: true - loop: false - effect: zoom - slide_effect: slide - width: 100% - height: auto - zoomable: true - draggable: true - skip_classes: - - custom-skip-class-name - auto_caption: false - caption_position: bottom - background: white - shadow: true - - # Simplifies configuring page titles and their order - # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin - - awesome-pages - - # Enables markdown files to be included in other markdown files - # https://github.com/mondeja/mkdocs-include-markdown-plugin - - include-markdown - - # Unleash the power of MkDocs with variables and macros - # https://github.com/fralau/mkdocs-macros-plugin - - macros - - # Support for D2 diagrams - # https://github.com/landmaj/mkdocs-d2-plugin - - d2 - - # Create page redirects (e.g. for moved/renamed pages) - # https://github.com/mkdocs/mkdocs-redirects - - redirects: - redirect_maps: - "concepts/manifest.md": "concepts/environments.md#manifesttoml" - "install-flox.md": "install-flox/install.md" + + # Excellent client-side search implementation, omitting the need for the + # integration of third-party services + # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#built-in-search-plugin + - search + + # The built-in optimize plugin automatically identifies and optimizes all + # media files as part of the build using compression and conversion + # techniques. + # https://squidfunk.github.io/mkdocs-material/setup/building-an-optimized-site/#built-in-optimize-plugin + - optimize + + # Lightbox - image zoom + # https://github.com/blueswen/mkdocs-glightbox + - glightbox: + touchNavigation: true + loop: false + effect: zoom + slide_effect: slide + width: 100% + height: auto + zoomable: true + draggable: true + skip_classes: + - custom-skip-class-name + auto_caption: false + caption_position: bottom + background: white + shadow: true + + # Simplifies configuring page titles and their order + # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin + - awesome-pages + + # Enables markdown files to be included in other markdown files + # https://github.com/mondeja/mkdocs-include-markdown-plugin + - include-markdown + + # Unleash the power of MkDocs with variables and macros + # https://github.com/fralau/mkdocs-macros-plugin + - macros + + # Support for D2 diagrams + # https://github.com/landmaj/mkdocs-d2-plugin + - d2 + + # Create page redirects (e.g. for moved/renamed pages) + # https://github.com/mkdocs/mkdocs-redirects + - redirects: + redirect_maps: + 'concepts/manifest.md': 'concepts/environments.md#manifesttoml' + 'install-flox.md': 'install-flox/install.md' From b3d4817609f233d7273af95a41eed229707933c8 Mon Sep 17 00:00:00 2001 From: Daniel Sauble Date: Wed, 1 Oct 2025 14:15:07 -0700 Subject: [PATCH 4/7] Use '/man' instead of '/manual' for man pages --- .flox/env/manifest.lock | 2 +- .flox/env/manifest.toml | 2 +- .gitignore | 2 +- check_links.sh | 2 +- docs/concepts/activation.md | 8 +++--- docs/concepts/builds.md | 2 +- docs/concepts/environments.md | 20 +++++++------- docs/concepts/flox-vs-containers.md | 14 +++++----- docs/concepts/floxhub.md | 14 +++++----- docs/concepts/generations.md | 8 +++--- docs/concepts/manifest-builds.md | 4 +-- docs/concepts/nix-expression-builds.md | 2 +- docs/concepts/packages-and-catalog.md | 8 +++--- docs/concepts/publishing.md | 10 +++---- docs/concepts/services.md | 2 +- docs/flox-5-minutes.md | 20 +++++++------- docs/index.md | 26 +++++++++---------- docs/languages/go.md | 2 +- docs/languages/nodejs.md | 2 +- docs/languages/rust.md | 2 +- docs/tutorials/build-and-publish.md | 14 +++++----- docs/tutorials/ci-cd.md | 2 +- docs/tutorials/composition.md | 10 +++---- docs/tutorials/creating-environments.md | 12 ++++----- docs/tutorials/customizing-environments.md | 6 ++--- docs/tutorials/default-environment.md | 6 ++--- .../layering-multiple-environments.md | 8 +++--- docs/tutorials/migrations/homebrew.md | 12 ++++----- docs/tutorials/migrations/nvm.md | 2 +- docs/tutorials/multi-arch-environments.md | 10 +++---- docs/tutorials/sharing-environments.md | 10 +++---- mkdocs.yml | 4 +-- 32 files changed, 124 insertions(+), 124 deletions(-) diff --git a/.flox/env/manifest.lock b/.flox/env/manifest.lock index 5e4f4567..18c2fe9a 100644 --- a/.flox/env/manifest.lock +++ b/.flox/env/manifest.lock @@ -40,7 +40,7 @@ } }, "hook": { - "on-activate": "\n#\n# Python environment activation and installation\n#\nexport POETRY_VIRTUALENVS_PATH=\"$FLOX_ENV_CACHE/poetry/virtualenvs\"\nif [ -z \"$(poetry env info --path)\" ]; then\n poetry env use \"$(which python)\" &> /dev/null\nfi\neval \"$(poetry env activate)\" &> /dev/null\npoetry install --quiet &> /dev/null\necho \"1. πŸ‘‰ Python environment activated\"\n\n# \n# Set the version of Flox to the latest stable version\n#\nexport FLOX_VERSION=$(cat FLOX_VERSION | xargs)\necho \"2. πŸ‘‰ FLOX_VERSION set to $FLOX_VERSION\"\n\n# \n# Copy and process Flox man pages\n# \nexport FLOX_SRC_ARCHIVE=\"$FLOX_ENV_CACHE/flox-v$FLOX_VERSION.tar.gz\"\nif [ ! -e \"$FLOX_SRC_ARCHIVE\" ]; then\n curl -sL \"https://github.com/flox/flox/archive/refs/tags/v$FLOX_VERSION.tar.gz\" -o $FLOX_SRC_ARCHIVE\nfi\necho \"3. πŸ‘‰ Downloaded Flox source archive\"\n\nexport FLOX_SRC_DIR=\"$FLOX_ENV_CACHE/flox-src-$FLOX_VERSION\"\nif [ ! -d \"$FLOX_SRC_DIR\" ]; then\n mkdir -p $FLOX_SRC_DIR\n tar -zx --strip-components=1 --file=$FLOX_SRC_ARCHIVE --directory=$FLOX_SRC_DIR;\nfi\necho \"4. πŸ‘‰ Extracted Flox source archive\"\n\nexport FLOX_MAN_PAGES_DIR=\"$PWD/docs/reference/command-reference\"\nif [ -d \"$FLOX_MAN_PAGES_DIR\" ]; then\n rm -rf \"$FLOX_MAN_PAGES_DIR/*\"\nfi\nmkdir -p $FLOX_MAN_PAGES_DIR\npushd \"$FLOX_SRC_DIR/cli/flox/doc\" > /dev/null\n find . -maxdepth 1 -iname \"*.md\" -exec \\\n sh -c \"\n pandoc -t gfm \\\n -L $FLOX_SRC_DIR/pkgs/flox-manpages/pandoc-filters/include-files.lua \\\n --standalone \\\n {} |\n # remove current title\n tail -n +6 |\n # indent all markdown levels by one, e.g. \"#\" -> \"##\"\n sed -e 's/^#/##/' > \\\"$FLOX_MAN_PAGES_DIR/{}\\\"\n \" \\;\npopd > /dev/null\npushd $FLOX_MAN_PAGES_DIR > /dev/null\n for commandPage in ./*.md; do\n # All other man page files have names of the form\n # 'flox*.md'\n if [ \"$commandPage\" = \"./manifest.toml.md\" ]; then\n continue\n fi\n command=$(basename $commandPage .md | sed -e \"s|-| |g\")\n echo -e \"\\n# \\`$command\\` command\\n$(cat $commandPage)\" > $commandPage\n echo -e \"---\\n$(cat $commandPage)\" > $commandPage\n echo -e \"description: Command reference for the \\`$command\\` command.\\n$(cat $commandPage)\" > $commandPage\n echo -e \"title: $command\\n$(cat $commandPage)\" > $commandPage\n echo -e \"---\\n$(cat $commandPage)\" > $commandPage\n done\n\n manifestPage=\"manifest.toml.md\"\n echo -e \"\\n# \\`manifest.toml\\`\\n$(cat $manifestPage)\" > $manifestPage\n echo -e \"---\\n$(cat $manifestPage)\" > $manifestPage\n echo -e \"description: Reference for the manifest.toml format.\\n$(cat $manifestPage)\" > $manifestPage\n echo -e \"title: manifest.toml\\n$(cat $manifestPage)\" > $manifestPage\n echo -e \"---\\n$(cat $manifestPage)\" > $manifestPage\npopd > /dev/null\necho \"5. πŸ‘‰ Copy man pages from Flox source archive\"\n" + "on-activate": "\n#\n# Python environment activation and installation\n#\nexport POETRY_VIRTUALENVS_PATH=\"$FLOX_ENV_CACHE/poetry/virtualenvs\"\nif [ -z \"$(poetry env info --path)\" ]; then\n poetry env use \"$(which python)\" &> /dev/null\nfi\neval \"$(poetry env activate)\" &> /dev/null\npoetry install --quiet &> /dev/null\necho \"1. πŸ‘‰ Python environment activated\"\n\n# \n# Set the version of Flox to the latest stable version\n#\nexport FLOX_VERSION=$(cat FLOX_VERSION | xargs)\necho \"2. πŸ‘‰ FLOX_VERSION set to $FLOX_VERSION\"\n\n# \n# Copy and process Flox man pages\n# \nexport FLOX_SRC_ARCHIVE=\"$FLOX_ENV_CACHE/flox-v$FLOX_VERSION.tar.gz\"\nif [ ! -e \"$FLOX_SRC_ARCHIVE\" ]; then\n curl -sL \"https://github.com/flox/flox/archive/refs/tags/v$FLOX_VERSION.tar.gz\" -o $FLOX_SRC_ARCHIVE\nfi\necho \"3. πŸ‘‰ Downloaded Flox source archive\"\n\nexport FLOX_SRC_DIR=\"$FLOX_ENV_CACHE/flox-src-$FLOX_VERSION\"\nif [ ! -d \"$FLOX_SRC_DIR\" ]; then\n mkdir -p $FLOX_SRC_DIR\n tar -zx --strip-components=1 --file=$FLOX_SRC_ARCHIVE --directory=$FLOX_SRC_DIR;\nfi\necho \"4. πŸ‘‰ Extracted Flox source archive\"\n\nexport FLOX_MAN_PAGES_DIR=\"$PWD/docs/man\"\nif [ -d \"$FLOX_MAN_PAGES_DIR\" ]; then\n rm -rf \"$FLOX_MAN_PAGES_DIR/*\"\nfi\nmkdir -p $FLOX_MAN_PAGES_DIR\npushd \"$FLOX_SRC_DIR/cli/flox/doc\" > /dev/null\n find . -maxdepth 1 -iname \"*.md\" -exec \\\n sh -c \"\n pandoc -t gfm \\\n -L $FLOX_SRC_DIR/pkgs/flox-manpages/pandoc-filters/include-files.lua \\\n --standalone \\\n {} |\n # remove current title\n tail -n +6 |\n # indent all markdown levels by one, e.g. \"#\" -> \"##\"\n sed -e 's/^#/##/' > \\\"$FLOX_MAN_PAGES_DIR/{}\\\"\n \" \\;\npopd > /dev/null\npushd $FLOX_MAN_PAGES_DIR > /dev/null\n for commandPage in ./*.md; do\n # All other man page files have names of the form\n # 'flox*.md'\n if [ \"$commandPage\" = \"./manifest.toml.md\" ]; then\n continue\n fi\n command=$(basename $commandPage .md | sed -e \"s|-| |g\")\n echo -e \"\\n# \\`$command\\` command\\n$(cat $commandPage)\" > $commandPage\n echo -e \"---\\n$(cat $commandPage)\" > $commandPage\n echo -e \"description: Command reference for the \\`$command\\` command.\\n$(cat $commandPage)\" > $commandPage\n echo -e \"title: $command\\n$(cat $commandPage)\" > $commandPage\n echo -e \"---\\n$(cat $commandPage)\" > $commandPage\n done\n\n manifestPage=\"manifest.toml.md\"\n echo -e \"\\n# \\`manifest.toml\\`\\n$(cat $manifestPage)\" > $manifestPage\n echo -e \"---\\n$(cat $manifestPage)\" > $manifestPage\n echo -e \"description: Reference for the manifest.toml format.\\n$(cat $manifestPage)\" > $manifestPage\n echo -e \"title: manifest.toml\\n$(cat $manifestPage)\" > $manifestPage\n echo -e \"---\\n$(cat $manifestPage)\" > $manifestPage\npopd > /dev/null\necho \"5. πŸ‘‰ Copy man pages from Flox source archive\"\n" }, "profile": { "common": "echo \"\"\necho \" ╔═══════════════════════════════════╗\"\necho \" β•‘ β•‘\"\necho \" β•‘ To build a production docs run: β•‘\"\necho \" β•‘ > mkdocs build β•‘\"\necho \" β•‘ β•‘\"\necho \" β•‘ To write docs locally run: β•‘\"\necho \" β•‘ > mkdocs serve β•‘\"\necho \" β•‘ β•‘\"\necho \" β•šβ•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•β•\"\necho \"\"\n", diff --git a/.flox/env/manifest.toml b/.flox/env/manifest.toml index e67dc742..df77ae2b 100644 --- a/.flox/env/manifest.toml +++ b/.flox/env/manifest.toml @@ -52,7 +52,7 @@ if [ ! -d "$FLOX_SRC_DIR" ]; then fi echo "4. πŸ‘‰ Extracted Flox source archive" -export FLOX_MAN_PAGES_DIR="$PWD/docs/manual" +export FLOX_MAN_PAGES_DIR="$PWD/docs/man" if [ -d "$FLOX_MAN_PAGES_DIR" ]; then rm -rf "$FLOX_MAN_PAGES_DIR/*" fi diff --git a/.gitignore b/.gitignore index 8dac0a1a..db1b430b 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,7 @@ .direnv/ site/ include/ -docs/manual +docs/man result result-* bin/ diff --git a/check_links.sh b/check_links.sh index 5dd3e093..f604a008 100755 --- a/check_links.sh +++ b/check_links.sh @@ -9,7 +9,7 @@ SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) lychee $SCRIPT_DIR/site \ -nv \ --remap "https://flox.dev/docs file://$PWD/site" \ - --exclude "bash/manual/html_node" \ + --exclude "bash/man/html_node" \ --exclude "https://www.gnu.org/software/make/" \ --exclude "https://github.com/flox/catalog-util" \ --exclude "https://www.backblaze.com/cloud-storage" diff --git a/docs/concepts/activation.md b/docs/concepts/activation.md index 194e4dd6..e26d693d 100644 --- a/docs/concepts/activation.md +++ b/docs/concepts/activation.md @@ -310,7 +310,7 @@ attach to this new version of the environment. ## Development vs. runtime mode -See the [`options.activate.mode`](../manual/manifest.toml.md#options) option in the manifest. +See the [`options.activate.mode`](../man/manifest.toml.md#options) option in the manifest. ## Conclusion @@ -329,6 +329,6 @@ that prepare your environment just how you like them. [environment-concept]: ./services.md [bash-func-export]: https://www.gnu.org/software/bash/manual/html_node/Bourne-Shell-Builtins.html#index-export -[vars-section]: ../manual/manifest.toml.md#vars -[hook-section]: ../manual/manifest.toml.md#hook -[profile-section]: ../manual/manifest.toml.md#profile +[vars-section]: ../man/manifest.toml.md#vars +[hook-section]: ../man/manifest.toml.md#hook +[profile-section]: ../man/manifest.toml.md#profile diff --git a/docs/concepts/builds.md b/docs/concepts/builds.md index c5183fe3..7207d351 100644 --- a/docs/concepts/builds.md +++ b/docs/concepts/builds.md @@ -42,5 +42,5 @@ One way to accomplish this is to run your builds in [CI][flox-ci-cd]. [manifest-builds-concept]: ./manifest-builds.md [nix-expression-builds-concept]: ./nix-expression-builds.md -[flox-build]: ../manual/flox-build.md +[flox-build]: ../man/flox-build.md [flox-ci-cd]: ../tutorials/ci-cd.md diff --git a/docs/concepts/environments.md b/docs/concepts/environments.md index b91eff82..8ee2be82 100644 --- a/docs/concepts/environments.md +++ b/docs/concepts/environments.md @@ -110,21 +110,21 @@ version. Flox manages this file for you. } ``` -[flox_init]: ../manual/flox-init.md -[flox_show]: ../manual/flox-show.md -[flox_edit]: ../manual/flox-edit.md -[flox_install]: ../manual/flox-install.md -[flox_search]: ../manual/flox-search.md -[flox_edit]: ../manual/flox-edit.md -[flox_push]: ../manual/flox-push.md -[flox_pull]: ../manual/flox-pull.md -[flox_activate]: ../manual/flox-activate.md +[flox_init]: ../man/flox-init.md +[flox_show]: ../man/flox-show.md +[flox_edit]: ../man/flox-edit.md +[flox_install]: ../man/flox-install.md +[flox_search]: ../man/flox-search.md +[flox_edit]: ../man/flox-edit.md +[flox_push]: ../man/flox-push.md +[flox_pull]: ../man/flox-pull.md +[flox_activate]: ../man/flox-activate.md [sharing_guide]: ../tutorials/sharing-environments.md [create_guide]: ../tutorials/creating-environments.md [customizing_environments_guide]: ../tutorials/customizing-environments.md [generation_concept]: ./generations.md [floxhub_concept]: ./floxhub.md [discourse]: https://discourse.flox.dev/ -[manifest]: ../manual/manifest.toml.md +[manifest]: ../man/manifest.toml.md [nix-expression-builds-concept]: ./nix-expression-builds.md [toml_spec]: https://toml.io/en/v1.0.0 diff --git a/docs/concepts/flox-vs-containers.md b/docs/concepts/flox-vs-containers.md index 26712c29..dd95c7d5 100644 --- a/docs/concepts/flox-vs-containers.md +++ b/docs/concepts/flox-vs-containers.md @@ -439,13 +439,13 @@ you need to build a container so that it can be deployed. --- -[init]: ../manual/flox-init.md -[edit]: ../manual/flox-edit.md -[install]: ../manual/flox-install.md -[push]: ../manual/flox-push.md -[containerize]: ../manual/flox-containerize.md -[activate]: ../manual/flox-activate.md -[services-start]: ../manual/flox-services-start.md +[init]: ../man/flox-init.md +[edit]: ../man/flox-edit.md +[install]: ../man/flox-install.md +[push]: ../man/flox-push.md +[containerize]: ../man/flox-containerize.md +[activate]: ../man/flox-activate.md +[services-start]: ../man/flox-services-start.md [services]: ../concepts/services.md [manifest]: ../concepts/environments.md#manifesttoml [early]: https://flox.dev/early/ diff --git a/docs/concepts/floxhub.md b/docs/concepts/floxhub.md index 65de3056..bfbd7162 100644 --- a/docs/concepts/floxhub.md +++ b/docs/concepts/floxhub.md @@ -97,13 +97,13 @@ flox pull example-owner/example-env Run the [`flox auth logout`][flox_auth] command. [flox_website]: https://flox.dev -[flox_push]: ../manual/flox-push.md -[flox_pull]: ../manual/flox-pull.md -[flox_activate]: ../manual/flox-activate.md -[flox_auth]: ../manual/flox-auth.md -[flox_edit]: ../manual/flox-edit.md -[flox_install]: ../manual/flox-install.md -[flox_uninstall]: ../manual/flox-uninstall.md +[flox_push]: ../man/flox-push.md +[flox_pull]: ../man/flox-pull.md +[flox_activate]: ../man/flox-activate.md +[flox_auth]: ../man/flox-auth.md +[flox_edit]: ../man/flox-edit.md +[flox_install]: ../man/flox-install.md +[flox_uninstall]: ../man/flox-uninstall.md [generation_concept]: ../concepts/generations.md [manifest_concept]: ../concepts/environments.md#manifesttoml [environments_concept]: ../concepts/environments.md diff --git a/docs/concepts/generations.md b/docs/concepts/generations.md index f983676b..64b763c8 100644 --- a/docs/concepts/generations.md +++ b/docs/concepts/generations.md @@ -79,9 +79,9 @@ This allows this environment to advance to newer generations explicitly on the next [`flox pull`][flox_pull]. [floxhub_concept]: .//floxhub.md -[flox_push]: ../manual/flox-push.md -[flox_install]: ../manual/flox-install.md -[flox_edit]: ../manual/flox-edit.md -[flox_pull]: ../manual/flox-pull.md +[flox_push]: ../man/flox-push.md +[flox_install]: ../man/flox-install.md +[flox_edit]: ../man/flox-edit.md +[flox_pull]: ../man/flox-pull.md [sharing_guide]: ../tutorials/sharing-environments.md [environment_guide]: ../tutorials/creating-environments.md diff --git a/docs/concepts/manifest-builds.md b/docs/concepts/manifest-builds.md index 4dbb1582..3d7d1dab 100644 --- a/docs/concepts/manifest-builds.md +++ b/docs/concepts/manifest-builds.md @@ -190,11 +190,11 @@ Each language guide in the Languages section of the Cookbook contains an example For example, [this section][go-example] contains an example build for the Go language. [builds-concept]: ./builds.md -[manifest-reference]: ../manual/manifest.toml.md#build +[manifest-reference]: ../man/manifest.toml.md#build [services-concept]: ./services.md [publish-concept]: ./publishing.md [fhs-docs]: https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard -[pkg-groups]: ../manual/manifest.toml.md#package-descriptors +[pkg-groups]: ../man/manifest.toml.md#package-descriptors [grpc]: https://grpc.io/ [organizations-concept]: ./organizations.md [go-example]: ../languages/go.md#build-with-flox diff --git a/docs/concepts/nix-expression-builds.md b/docs/concepts/nix-expression-builds.md index 1c9e3553..b8082d6c 100644 --- a/docs/concepts/nix-expression-builds.md +++ b/docs/concepts/nix-expression-builds.md @@ -242,4 +242,4 @@ error: hash mismatch in fixed-output derivation '/nix/store/srm7s6pyckifs52ikyfa [builds-concept]: ./builds.md [manifest-builds-concept]: ./manifest-builds.md -[pkg-groups]: ../manual/manifest.toml.md#package-descriptors +[pkg-groups]: ../man/manifest.toml.md#package-descriptors diff --git a/docs/concepts/packages-and-catalog.md b/docs/concepts/packages-and-catalog.md index 5e78c6aa..53de4534 100644 --- a/docs/concepts/packages-and-catalog.md +++ b/docs/concepts/packages-and-catalog.md @@ -38,10 +38,10 @@ Source by the Open Source Initiative (OSI). * **broken**: indicates if the package is marked as broken in [nixpkgs][nixpkgs]. -[flox_search]: ../manual/flox-search.md -[flox_show]: ../manual/flox-show.md -[flox_install]: ../manual/flox-install.md -[flox_update]: ../manual/flox-update.md +[flox_search]: ../man/flox-search.md +[flox_show]: ../man/flox-show.md +[flox_install]: ../man/flox-install.md +[flox_update]: ../man/flox-update.md [manifest_concept]: ./environments.md#manifesttoml [nixpkgs]: https://github.com/NixOS/nixpkgs [builds]: ./builds.md diff --git a/docs/concepts/publishing.md b/docs/concepts/publishing.md index ce1bcd84..145abb1f 100644 --- a/docs/concepts/publishing.md +++ b/docs/concepts/publishing.md @@ -83,9 +83,9 @@ For anyone in the organization, published packages become available in [builds-concept]: ./builds.md [catalog-concept]: ./packages-and-catalog.md -[flox-build]: ../manual/flox-build.md -[flox-publish]: ../manual/flox-publish.md -[flox-search]: ../manual/flox-search.md -[flox-show]: ../manual/flox-show.md -[flox-install]: ../manual/flox-install.md +[flox-build]: ../man/flox-build.md +[flox-publish]: ../man/flox-publish.md +[flox-search]: ../man/flox-search.md +[flox-show]: ../man/flox-show.md +[flox-install]: ../man/flox-install.md [organizations-concept]: ./organizations.md diff --git a/docs/concepts/services.md b/docs/concepts/services.md index b8d96254..431ce03f 100644 --- a/docs/concepts/services.md +++ b/docs/concepts/services.md @@ -28,7 +28,7 @@ Services have a very simple schema consisting of a `command` to run to start the service, any `vars` you want set specifically for the service, and whether the service spawns a background process. -See [`manifest-toml(1)`](../manual/manifest.toml.md) for +See [`manifest-toml(1)`](../man/manifest.toml.md) for more details on the exact format of the `[services]` section of the manfiest. An example service definition is shown below: diff --git a/docs/flox-5-minutes.md b/docs/flox-5-minutes.md index 699ff628..643e9b72 100644 --- a/docs/flox-5-minutes.md +++ b/docs/flox-5-minutes.md @@ -252,23 +252,23 @@ There are _so_ many things we didn't have time to cover, so here's some addition [install_flox]: ./install-flox/install.md [create_guide]: ./tutorials/creating-environments.md [sharing]: ./tutorials/sharing-environments.md -[init]: ./manual/flox-init.md -[search]: ./manual/flox-search.md -[show]: ./manual/flox-show.md +[init]: ./man/flox-init.md +[search]: ./man/flox-search.md +[show]: ./man/flox-show.md [catalog]: ./concepts/packages-and-catalog.md -[install]: ./manual/flox-install.md -[activate]: ./manual/flox-activate.md -[edit]: ./manual/flox-edit.md -[push]: ./manual/flox-push.md -[list]: ./manual/flox-list.md -[manifest]: ./manual/manifest.toml.md +[install]: ./man/flox-install.md +[activate]: ./man/flox-activate.md +[edit]: ./man/flox-edit.md +[push]: ./man/flox-push.md +[list]: ./man/flox-list.md +[manifest]: ./man/manifest.toml.md [multi-arch]: ./tutorials/multi-arch-environments.md [services]: ./concepts/services.md [bun]: https://bun.sh/ [zig]: https://ziglang.org/ [floxhub]: https://hub.flox.dev [sleep-issue]: https://github.com/flox/flox/pull/1931 -[install-section]: ./manual/manifest.toml.md#install +[install-section]: ./man/manifest.toml.md#install [activation-tutorial]: ./tutorials/customizing-environments.md [ci]: ./tutorials/ci-cd.md [composition]: ./tutorials/composition.md diff --git a/docs/index.md b/docs/index.md index 65e8782a..5e5fa8a9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -108,7 +108,7 @@ If you're already using Homebrew, you can easily [migrate or use Homebrew and Fl Flox lets you define what an environment _is_ in a way that can be reused across local dev, CI, and production. Leverage [pre-built integrations](https://flox.dev/docs/tutorials/ci-cd/?h=ci) for GitHub Actions, CircleCI, and GitLab to pull and activate the same environments locally, in CI and in production. -Or use Flox [containerize](https://flox.dev/docs/manual/flox-containerize/?h=containerize) to package your environments as OCI imagesβ€”fully pinned and runnable anywhere. +Or use Flox [containerize](https://flox.dev/docs/man/flox-containerize/?h=containerize) to package your environments as OCI imagesβ€”fully pinned and runnable anywhere. From bare metal to VMs, from Docker Swarm to Kubernetes to AWS Lambdaβ€”the runtime context might change, but Flox environments run and behave the same everywhere. Need an example? See how [the Flox Docs team uses Flox in CI](https://flox.dev/blog/integrating-flox-with-ci-for-consistent-reproducible-dev-environments/) to build, test and deploy this docs site. @@ -131,20 +131,20 @@ The Flox product and engineering teams love to hear directly from users. Your qu [flox_5_minutes]: ./flox-5-minutes.md [create_guide]: ./tutorials/creating-environments.md [share_guide]: ./tutorials/sharing-environments.md -[init]: ./manual/flox-init.md -[search]: ./manual/flox-search.md -[show]: ./manual/flox-show.md +[init]: ./man/flox-init.md +[search]: ./man/flox-search.md +[show]: ./man/flox-show.md [catalog]: ./concepts/packages-and-catalog.md -[install]: ./manual/flox-install.md -[activate]: ./manual/flox-activate.md -[edit]: ./manual/flox-edit.md -[push]: ./manual/flox-push.md -[pull]: ./manual/flox-pull.md -[delete]: ./manual/flox-delete.md -[list]: ./manual/flox-list.md -[manifest]: ./manual/manifest.toml.md +[install]: ./man/flox-install.md +[activate]: ./man/flox-activate.md +[edit]: ./man/flox-edit.md +[push]: ./man/flox-push.md +[pull]: ./man/flox-pull.md +[delete]: ./man/flox-delete.md +[list]: ./man/flox-list.md +[manifest]: ./man/manifest.toml.md [rust-cookbook]: ./languages/rust.md [multi-arch]: ./tutorials/multi-arch-environments.md -[config]: ./manual/flox-config.md +[config]: ./man/flox-config.md [services]: ./concepts/services.md [floxhub_packages]: https://hub.flox.dev/packages diff --git a/docs/languages/go.md b/docs/languages/go.md index cb93b262..b9906957 100644 --- a/docs/languages/go.md +++ b/docs/languages/go.md @@ -93,7 +93,7 @@ sandbox = "pure" ### Nix expression builds -To build a project using [`buildGoModule`](https://nixos.org/manual/nixpkgs/stable/#sec-language-go) which will import your existing dependency file, but you will need to [update the hash][nix-expression-hashes]: +To build a project using [`buildGoModule`](https://nixos.org/man/nixpkgs/stable/#sec-language-go) which will import your existing dependency file, but you will need to [update the hash][nix-expression-hashes]: ```go { buildGoModule }: diff --git a/docs/languages/nodejs.md b/docs/languages/nodejs.md index 53ba5ce7..be57a2ec 100644 --- a/docs/languages/nodejs.md +++ b/docs/languages/nodejs.md @@ -76,7 +76,7 @@ sandbox = "pure" ### Nix expression builds -To build a project using [`buildNpmPackage`](https://nixos.org/manual/nixpkgs/stable/#language-javascript) which will import your existing dependency file: +To build a project using [`buildNpmPackage`](https://nixos.org/man/nixpkgs/stable/#language-javascript) which will import your existing dependency file: ```nix { diff --git a/docs/languages/rust.md b/docs/languages/rust.md index a0bd353f..ca011066 100644 --- a/docs/languages/rust.md +++ b/docs/languages/rust.md @@ -269,7 +269,7 @@ runtime-packages = ["libiconv", "gcc"] ### Nix expression builds -To build a project using [`buildRustPackage`](https://nixos.org/manual/nixpkgs/stable/#rust) which will import your existing dependency file: +To build a project using [`buildRustPackage`](https://nixos.org/man/nixpkgs/stable/#rust) which will import your existing dependency file: ```nix { rustPlatform }: diff --git a/docs/tutorials/build-and-publish.md b/docs/tutorials/build-and-publish.md index 57355a55..2daa9c5b 100644 --- a/docs/tutorials/build-and-publish.md +++ b/docs/tutorials/build-and-publish.md @@ -256,15 +256,15 @@ The story doesn't end here though. In this guide we've shown you how to build and distribute programs, but you can also use it to distribute configuration files (or any other file). See the [builds][extra-builds] concept page for examples of what else you can build and publish with Flox. -[flox-manifest-build-section]: ../manual/manifest.toml.md#build +[flox-manifest-build-section]: ../man/manifest.toml.md#build [build-concept]: ../concepts/builds.md [fhs]: https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard -[flox-install]: ../manual/flox-install.md -[flox-show]: ../manual/flox-show.md -[flox-search]: ../manual/flox-search.md -[flox-edit]: ../manual/flox-edit.md -[flox-build]: ../manual/flox-build.md -[flox-publish]: ../manual/flox-publish.md +[flox-install]: ../man/flox-install.md +[flox-show]: ../man/flox-show.md +[flox-search]: ../man/flox-search.md +[flox-edit]: ../man/flox-edit.md +[flox-build]: ../man/flox-build.md +[flox-publish]: ../man/flox-publish.md [extra-builds]: ../concepts/manifest-builds.md#example-configuration-files [publish-concept]: ../concepts/publishing.md [organizations-concept]: ../concepts/organizations.md diff --git a/docs/tutorials/ci-cd.md b/docs/tutorials/ci-cd.md index 9e9e3899..788c17f8 100644 --- a/docs/tutorials/ci-cd.md +++ b/docs/tutorials/ci-cd.md @@ -121,4 +121,4 @@ Here are some suggestions for things you can do with your Flox environment in CI [sharing_guide]: ./sharing-environments.md [layering_guide]: ./layering-multiple-environments.md [customizing_guide]: ./customizing-environments.md -[containerize]: ../manual/flox-containerize.md +[containerize]: ../man/flox-containerize.md diff --git a/docs/tutorials/composition.md b/docs/tutorials/composition.md index 2267c72b..2da10762 100644 --- a/docs/tutorials/composition.md +++ b/docs/tutorials/composition.md @@ -297,10 +297,10 @@ This means you can spend less time getting started, and more time developing you Similarly, since you're treating environments like dependencies, if you make an improvement to a template environment while working on one project, the improvement will become available to all of your other projects that use that environment as soon as they run `flox include upgrade`. [poetry]: https://python-poetry.org/ -[flox-init]: ../manual/flox-init.md -[flox-pull]: ../manual/flox-pull.md -[flox-install]: ../manual/flox-install.md -[flox-edit]: ../manual/flox-edit.md -[flox-list]: ../manual/flox-list.md +[flox-init]: ../man/flox-init.md +[flox-pull]: ../man/flox-pull.md +[flox-install]: ../man/flox-install.md +[flox-edit]: ../man/flox-edit.md +[flox-list]: ../man/flox-list.md [floxhub]: ../concepts/floxhub.md [hypothesis]: https://hypothesis.readthedocs.io/en/latest/ diff --git a/docs/tutorials/creating-environments.md b/docs/tutorials/creating-environments.md index 49053113..bb4db40f 100644 --- a/docs/tutorials/creating-environments.md +++ b/docs/tutorials/creating-environments.md @@ -228,13 +228,13 @@ flox [example-project] $ exit $ ``` -[flox_init]: ../manual/flox-init.md -[flox_search]: ../manual/flox-search.md -[flox_show]: ../manual/flox-show.md -[flox_install]: ../manual/flox-install.md +[flox_init]: ../man/flox-init.md +[flox_search]: ../man/flox-search.md +[flox_show]: ../man/flox-show.md +[flox_install]: ../man/flox-install.md [discourse]: https://discourse.floxdev.com/ -[flox_activate]: ../manual/flox-activate.md -[flox_edit]: ../manual/flox-edit.md +[flox_activate]: ../man/flox-activate.md +[flox_edit]: ../man/flox-edit.md [sharing_guide]: ./sharing-environments.md [layering_guide]: ./layering-multiple-environments.md [manifest_concept]: ../concepts/environments.md#manifesttoml diff --git a/docs/tutorials/customizing-environments.md b/docs/tutorials/customizing-environments.md index 6434146e..36d7ea7d 100644 --- a/docs/tutorials/customizing-environments.md +++ b/docs/tutorials/customizing-environments.md @@ -174,10 +174,10 @@ mycli - :simple-readme:{ .flox-purple .flox-heart } [Multiple architecture environments][multi-arch-guide] [environment_concept]: ../concepts/environments.md -[flox_activate]: ../manual/flox-activate.md +[flox_activate]: ../man/flox-activate.md [multi-arch-guide]: ./multi-arch-environments.md [rust_guide]: ../languages/rust.md -[flox_init]: ../manual/flox-init.md +[flox_init]: ../man/flox-init.md [activation_concept]: ../concepts/activation.md [fish_shell]: https://fishshell.com/ -[flox_install]: ../manual/flox-install.md +[flox_install]: ../man/flox-install.md diff --git a/docs/tutorials/default-environment.md b/docs/tutorials/default-environment.md index 4a898ccd..de374574 100644 --- a/docs/tutorials/default-environment.md +++ b/docs/tutorials/default-environment.md @@ -247,6 +247,6 @@ Flox has you covered. Even better, if you want both a package manager _and_ developer environments, with Flox you only need to learn one tool. -[init]: ../manual/flox-init.md -[push]: ../manual/flox-push.md -[pull]: ../manual/flox-pull.md +[init]: ../man/flox-init.md +[push]: ../man/flox-push.md +[pull]: ../man/flox-pull.md diff --git a/docs/tutorials/layering-multiple-environments.md b/docs/tutorials/layering-multiple-environments.md index 266400f7..4b75a8f8 100644 --- a/docs/tutorials/layering-multiple-environments.md +++ b/docs/tutorials/layering-multiple-environments.md @@ -127,10 +127,10 @@ Inactive environments: - :simple-readme:{ .flox-purple .flox-heart } [Designing multiple architecture environments][multi_arch_guide] [default-env]: ./default-environment.md -[flox_init]: ../manual/flox-init.md -[flox_install]: ../manual/flox-install.md -[flox_activate]: ../manual/flox-activate.md -[flox_list]: ../manual/flox-list.md +[flox_init]: ../man/flox-init.md +[flox_install]: ../man/flox-install.md +[flox_activate]: ../man/flox-activate.md +[flox_list]: ../man/flox-list.md [sharing_guide]: ./sharing-environments.md [customizing_guide]: ./customizing-environments.md [multi_arch_guide]: ./multi-arch-environments.md diff --git a/docs/tutorials/migrations/homebrew.md b/docs/tutorials/migrations/homebrew.md index 6382ebef..77311e27 100644 --- a/docs/tutorials/migrations/homebrew.md +++ b/docs/tutorials/migrations/homebrew.md @@ -202,10 +202,10 @@ We recommend that the Flox default environment activation lines appear lowest in [default_tutorial_setup]: ../default-environment.md#initial-setup [creating_tutorial]: ../creating-environments.md [install_flox]: ../../install-flox/install.md -[search]: ../../manual/flox-search.md -[envs]: ../../manual/flox-envs.md -[list]: ../../manual/flox-list.md +[search]: ../../man/flox-search.md +[envs]: ../../man/flox-envs.md +[list]: ../../man/flox-list.md [catalog]: ../../concepts/packages-and-catalog.md -[install]: ../../manual/flox-install.md -[uninstall]: ../../manual/flox-uninstall.md -[activate]: ../../manual/flox-activate.md +[install]: ../../man/flox-install.md +[uninstall]: ../../man/flox-uninstall.md +[activate]: ../../man/flox-activate.md diff --git a/docs/tutorials/migrations/nvm.md b/docs/tutorials/migrations/nvm.md index 92a9ec33..90c54514 100644 --- a/docs/tutorials/migrations/nvm.md +++ b/docs/tutorials/migrations/nvm.md @@ -189,5 +189,5 @@ Now that you're managing your project's Node.js version using Flox, you can `git [environment_concept]: ../../concepts/environments.md [install_flox]: ../../install-flox/install.md -[manifest]: ../../manual/manifest.toml.md +[manifest]: ../../man/manifest.toml.md [services]: ../../concepts/services.md diff --git a/docs/tutorials/multi-arch-environments.md b/docs/tutorials/multi-arch-environments.md index 59f40e2d..826e240e 100644 --- a/docs/tutorials/multi-arch-environments.md +++ b/docs/tutorials/multi-arch-environments.md @@ -138,8 +138,8 @@ get the `systemd` package. [environment_concept]: ../concepts/environments.md [sharing_guide]: ./sharing-environments.md -[flox_search]: ../manual/flox-search.md -[flox_show]: ../manual/flox-show.md -[flox_edit]: ../manual/flox-edit.md -[flox_push]: ../manual/flox-push.md -[flox_pull]: ../manual/flox-pull.md +[flox_search]: ../man/flox-search.md +[flox_show]: ../man/flox-show.md +[flox_edit]: ../man/flox-edit.md +[flox_push]: ../man/flox-push.md +[flox_pull]: ../man/flox-pull.md diff --git a/docs/tutorials/sharing-environments.md b/docs/tutorials/sharing-environments.md index 1a7e0cc6..c4afa532 100644 --- a/docs/tutorials/sharing-environments.md +++ b/docs/tutorials/sharing-environments.md @@ -54,7 +54,7 @@ git clone ..example-project; flox activate ``` -[flox_init]: ../manual/flox-init.md +[flox_init]: ../man/flox-init.md [discourse]: https://discourse.flox.dev/ [manifest_concept]: ../concepts/environments.md#manifesttoml @@ -128,9 +128,9 @@ $ flox push !!! note "Note" Right now, only environment owners can push edits to their environments. -[flox_push]: ../manual/flox-push.md -[flox_pull]: ../manual/flox-pull.md -[flox_activate]: ../manual/flox-activate.md +[flox_push]: ../man/flox-push.md +[flox_pull]: ../man/flox-pull.md +[flox_activate]: ../man/flox-activate.md [floxhub_concept]: ../concepts/floxhub.md ### Pulling a remote environment without connecting to FloxHub @@ -228,4 +228,4 @@ telnet (GNU inetutils) 2.5 [environment_concept]: ../concepts/environments.md [layering_guide]: ./layering-multiple-environments.md [customizing_guide]: ./customizing-environments.md -[flox_containerize]: ../manual/flox-containerize.md +[flox_containerize]: ../man/flox-containerize.md diff --git a/mkdocs.yml b/mkdocs.yml index 0bb79e2f..4aaaf079 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,8 +68,8 @@ nav: - Languages: - ... | flat | languages/* - Manual: - - manual/flox.md - - ... | flat | manual/* + - man/flox.md + - ... | flat | man/* strict: true validation: From d8f5ec8cf6e24e9cc8c0068018a2836dadd318dd Mon Sep 17 00:00:00 2001 From: Daniel Sauble Date: Wed, 1 Oct 2025 14:21:54 -0700 Subject: [PATCH 5/7] Add redirects --- mkdocs.yml | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 4aaaf079..1d51865e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -308,3 +308,43 @@ plugins: redirect_maps: 'concepts/manifest.md': 'concepts/environments.md#manifesttoml' 'install-flox.md': 'install-flox/install.md' + 'reference/command-reference/flox-activate.md': 'man/flox-activate.md' + 'reference/command-reference/flox-auth.md': 'man/flox-auth.md' + 'reference/command-reference/flox-build-clean.md': 'man/flox-build-clean.md' + 'reference/command-reference/flox-build-import-nixpkgs.md': 'man/flox-build-import-nixpkgs.md' + 'reference/command-reference/flox-build.md': 'man/flox-build.md' + 'reference/command-reference/flox-config.md': 'man/flox-config.md' + 'reference/command-reference/flox-containerize.md': 'man/flox-containerize.md' + 'reference/command-reference/flox-delete.md': 'man/flox-delete.md' + 'reference/command-reference/flox-edit.md': 'man/flox-edit.md' + 'reference/command-reference/flox-envs.md': 'man/flox-envs.md' + 'reference/command-reference/flox-gc.md': 'man/flox-gc.md' + 'reference/command-reference/flox-generations-history.md': 'man/flox-generations-history.md' + 'reference/command-reference/flox-generations-list.md': 'man/flox-generations-list.md' + 'reference/command-reference/flox-generations-rollback.md': 'man/flox-generations-rollback.md' + 'reference/command-reference/flox-generations-switch.md': 'man/flox-generations-switch.md' + 'reference/command-reference/flox-include-upgrade.md': 'man/flox-include-upgrade.md' + 'reference/command-reference/flox-init.md': 'man/flox-init.md' + 'reference/command-reference/flox-install.md': 'man/flox-install.md' + 'reference/command-reference/flox-list.md': 'man/flox-list.md' + 'reference/command-reference/flox-publish.md': 'man/flox-publish.md' + 'reference/command-reference/flox-pull.md': 'man/flox-pull.md' + 'reference/command-reference/flox-push.md': 'man/flox-push.md' + 'reference/command-reference/flox-search.md': 'man/flox-search.md' + 'reference/command-reference/flox-services-logs.md': 'man/flox-services-logs.md' + 'reference/command-reference/flox-services-restart.md': 'man/flox-services-restart.md' + 'reference/command-reference/flox-services-start.md': 'man/flox-services-start.md' + 'reference/command-reference/flox-services-status.md': 'man/flox-services-status.md' + 'reference/command-reference/flox-services-stop.md': 'man/flox-services-stop.md' + 'reference/command-reference/flox-show.md': 'man/flox-show.md' + 'reference/command-reference/flox-uninstall.md': 'man/flox-uninstall.md' + 'reference/command-reference/flox-upgrade.md': 'man/flox-upgrade.md' + 'reference/command-reference/flox.md': 'man/flox.md' + 'reference/command-reference/manifest.toml.md': 'man/manifest.toml.md' + 'cookbook/languages/c.md': 'languages/c.md' + 'cookbook/languages/go.md': 'languages/go.md' + 'cookbook/languages/jvm.md': 'languages/jvm.md' + 'cookbook/languages/nodejs.md': 'languages/nodejs.md' + 'cookbook/languages/python.md': 'languages/python.md' + 'cookbook/languages/ruby.md': 'languages/ruby.md' + 'cookbook/languages/rust.md': 'languages/rust.md' From b8b428f631bb31c4d9b4efdd809412bfad98b7c6 Mon Sep 17 00:00:00 2001 From: Daniel Sauble Date: Wed, 1 Oct 2025 14:29:15 -0700 Subject: [PATCH 6/7] Revert some bad search/replace --- docs/languages/go.md | 2 +- docs/languages/nodejs.md | 2 +- docs/languages/rust.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/languages/go.md b/docs/languages/go.md index b9906957..cb93b262 100644 --- a/docs/languages/go.md +++ b/docs/languages/go.md @@ -93,7 +93,7 @@ sandbox = "pure" ### Nix expression builds -To build a project using [`buildGoModule`](https://nixos.org/man/nixpkgs/stable/#sec-language-go) which will import your existing dependency file, but you will need to [update the hash][nix-expression-hashes]: +To build a project using [`buildGoModule`](https://nixos.org/manual/nixpkgs/stable/#sec-language-go) which will import your existing dependency file, but you will need to [update the hash][nix-expression-hashes]: ```go { buildGoModule }: diff --git a/docs/languages/nodejs.md b/docs/languages/nodejs.md index be57a2ec..53ba5ce7 100644 --- a/docs/languages/nodejs.md +++ b/docs/languages/nodejs.md @@ -76,7 +76,7 @@ sandbox = "pure" ### Nix expression builds -To build a project using [`buildNpmPackage`](https://nixos.org/man/nixpkgs/stable/#language-javascript) which will import your existing dependency file: +To build a project using [`buildNpmPackage`](https://nixos.org/manual/nixpkgs/stable/#language-javascript) which will import your existing dependency file: ```nix { diff --git a/docs/languages/rust.md b/docs/languages/rust.md index ca011066..a0bd353f 100644 --- a/docs/languages/rust.md +++ b/docs/languages/rust.md @@ -269,7 +269,7 @@ runtime-packages = ["libiconv", "gcc"] ### Nix expression builds -To build a project using [`buildRustPackage`](https://nixos.org/man/nixpkgs/stable/#rust) which will import your existing dependency file: +To build a project using [`buildRustPackage`](https://nixos.org/manual/nixpkgs/stable/#rust) which will import your existing dependency file: ```nix { rustPlatform }: From 3cc0e1376d710d3fe67527fb316d030786dc4b55 Mon Sep 17 00:00:00 2001 From: Daniel Sauble Date: Wed, 1 Oct 2025 16:11:09 -0700 Subject: [PATCH 7/7] Fix exclusion for the bash manual --- check_links.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/check_links.sh b/check_links.sh index f604a008..5dd3e093 100755 --- a/check_links.sh +++ b/check_links.sh @@ -9,7 +9,7 @@ SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd ) lychee $SCRIPT_DIR/site \ -nv \ --remap "https://flox.dev/docs file://$PWD/site" \ - --exclude "bash/man/html_node" \ + --exclude "bash/manual/html_node" \ --exclude "https://www.gnu.org/software/make/" \ --exclude "https://github.com/flox/catalog-util" \ --exclude "https://www.backblaze.com/cloud-storage"