jeff merge #308
Merged
jeff merge #308
+2,962
−30
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Remove author WIP/TODO notes from examples.md, install.md, reference-guide.md - Update documentation link in faq.md to point to docs/ instead of manual/
- Fix heading typo "Exapmle" -> "Example" for HTTPS nginx section - Remove TOC entries for sections that don't exist in reference-guide.md - Fix cross-page link in install.md to reference-guide.md - Remove stale "FAQ" TODO note from TOC
This reverts commit 05bdd9c.
Apply backticks to: - File paths (/etc/nix/nix.conf, ~/.config/system-manager, etc.) - File names (flake.nix, system.nix, .nix files) - Package names (bat, tree, hello, etc.) - Nix attributes (systemPackages, wantedBy, config, etc.) - Commands and options (--sudo, --flake, init, switch, etc.) - Environment variables (PATH, $PATH) Also fix several typos: "bulit-in" -> "built-in", "imputs" -> "inputs", "sipmly" -> "simply", "inluding" -> "including", "ngnix" -> "nginx", "have to" -> "having to", and fix /opt/nix/nix.conf to /etc/nix/nix.conf.
- Remove redundant admonitions that repeated bullet list items
- Rename "Installation" to "No Installation Required" for clarity
- Add first-run example command with link to getting-started.md
- Rename "Regarding Experimental Features" to "Enabling Flakes"
- Simplify experimental features section, link to reference-guide.md
- Add language identifiers to code blocks (ini, sh, console)
- Fix awkward phrasing ("installed off of" -> "installed in")
- Remove extra blank lines
- Rename page from "System Requirements" to "Installation" - Add "Installing Nix" section with official multi-user installer - Add "Enabling Flakes" section (required after official install) - Link to nix-install.com for alternative installation options - Add "Checking Your Installation" section for system-wide verification - Update nav and all links to use install.md
The --sudo flag is about running System Manager, not installing it. Move the explanation to where users first encounter the switch command, with a clearer description of what it does.
Remove duplicate explanations of Nix flakes/experimental features from getting-started.md and reference-guide.md. These now reference the canonical "Enabling Flakes" section in install.md.
Reorganize the monolithic reference-guide.md (~2000 lines) into a structured reference/ subdirectory with focused files: - reference/index.md: Overview linking to all sections - reference/cli.md: CLI commands and local installation - reference/configuration.md: Project setup and workflows - reference/modules.md: Services, packages, /etc, tmpfiles - reference/remote-flakes.md: Remote flake hosting - reference/blueprint.md: Blueprint integration - reference/examples/: Individual example files (timer, docker, postgresql, nginx, nginx-https, custom-app) Also migrates examples from examples.md into the new structure and updates all cross-references.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Merges changes from #287