diff --git a/docs/Community.md b/docs/misc/Community.md similarity index 100% rename from docs/Community.md rename to docs/misc/Community.md diff --git a/docs/FAQ.md b/docs/misc/FAQ.md similarity index 87% rename from docs/FAQ.md rename to docs/misc/FAQ.md index a11ac9b41e..59339c20fd 100644 --- a/docs/FAQ.md +++ b/docs/misc/FAQ.md @@ -11,9 +11,10 @@ ## Why the name `pixi` Starting with the name `prefix` we iterated until we had a name that was easy to pronounce, spell and remember. -There also wasn't a cli tool yet using that name. +There also wasn't a CLI tool yet using that name. Unlike `px`, `pex`, `pax`, etc. -We think it sparks curiosity and fun, if you don't agree, I'm sorry, but you can always alias it to whatever you like. +When in code mode we spell it like this `pixi`, otherwise we always start with an uppercase letter: Pixi. +We think the name sparks curiosity and fun, if you don't agree, I'm sorry, but you can always alias it to whatever you like. === "Linux & macOS" ```shell diff --git a/docs/misc/documenting_pixi.md b/docs/misc/documenting_pixi.md new file mode 100644 index 0000000000..94a4c13edf --- /dev/null +++ b/docs/misc/documenting_pixi.md @@ -0,0 +1 @@ +# Documenting Pixi diff --git a/docs/packaging.md b/docs/misc/packaging.md similarity index 100% rename from docs/packaging.md rename to docs/misc/packaging.md diff --git a/docs/vision.md b/docs/misc/vision.md similarity index 100% rename from docs/vision.md rename to docs/misc/vision.md diff --git a/docs/workspace/multi_platform_configuration.md b/docs/workspace/multi_platform_configuration.md index 16307e934c..27f4f85784 100644 --- a/docs/workspace/multi_platform_configuration.md +++ b/docs/workspace/multi_platform_configuration.md @@ -1,5 +1,5 @@ -[Pixi's vision](../vision.md) includes being supported on all major platforms. Sometimes that needs some extra configuration to work well. +[Pixi's vision](../misc/vision.md) includes being supported on all major platforms. Sometimes that needs some extra configuration to work well. On this page, you will learn what you can configure to align better with the platform you are making your application for. Here is an example manifest file that highlights some of the features: diff --git a/mkdocs.yml b/mkdocs.yml index 229e313059..417052c8a5 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -158,10 +158,10 @@ nav: - CLI: reference/cli/pixi.md - Misc: - Changelog: CHANGELOG.md - - Pixi Vision: vision.md - - Packaging Pixi: packaging.md - - Community: Community.md - - FAQ: FAQ.md + - Pixi Vision: misc/vision.md + - Packaging Pixi: misc/packaging.md + - Community: misc/Community.md + - FAQ: misc/FAQ.md hooks: - schema/docs_hooks.py @@ -200,6 +200,10 @@ plugins: "advanced/s3.md": "deployment/s3.md" "advanced/third_party.md": "integration/third_party/starship.md" "reference/cli.md": "reference/cli/pixi.md" + "vision.md": "misc/vision.md" + "packaging.md": "misc/packaging.md" + "Community.md": "misc/Community.md" + "FAQ.md": "misc/FAQ.md" - search - social