docs: improve README and align flake update workflow

[yxtay]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the onboarding and maintenance experience for the dotfiles repository by providing extensive documentation and standardizing the Nix flake update process. The changes make it easier for users to understand the repository's structure, set up their environment, and manage their system configurations consistently.

Highlights

• Documentation Enhancement: The README.md has been significantly expanded to provide comprehensive guidance on the dotfiles repository, covering its structure, prerequisites, setup, configuration application (Nix Darwin, Home Manager), development workflow, and maintenance scripts.
• Nix Flake Host Alignment: The host.name in flake.nix was generalized from a specific machine identifier to "Mac", and the scripts/update-all.sh was updated to reflect this change, ensuring consistent application of the Nix Darwin configuration.

Changelog

• README.md
  • Expanded the initial description to clarify the use of chezmoi and Nix flakes (nix-darwin + home-manager).
  • Added a "What's in this repo" section detailing the directory structure and their purposes.
  • Included a "Prerequisites" section listing necessary tools.
  • Provided detailed instructions for "Bootstrap with chezmoi", "Apply system config (nix-darwin)", and "Apply user config (home-manager standalone)".
  • Introduced sections for "Development workflow" and "Maintenance scripts" with command examples and notes.
  • Added "Host/User defaults" to clarify flake configurations.
• flake.nix
  • Modified the host.name variable within the outputs let-binding from "yx-tay-pkf2k" to "Mac".
• scripts/update-all.sh
  • Updated the sudo sh -c 'nix ... run nix-darwin -- switch --flake .' command to explicitly include #Mac at the end of the flake path, i.e., sudo sh -c 'nix ... run nix-darwin -- switch --flake .#Mac'.

Activity

• No human activity has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

KICS version: v2.1.20

Category Results CRITICAL 0 HIGH 0 MEDIUM 0 LOW 0 INFO 0 TRACE 0 TOTAL 0	Metric Values Files scanned 6 Files parsed 6 Files failed to scan 0 Total executed queries 4 Queries failed to execute 0 Execution time 0

Queries Results

| |

[gemini-code-assist]

Code Review

This pull request significantly improves the documentation in README.md and aligns the flake update workflow by standardizing the hostname to Mac. The changes are consistent across the modified files. I have one suggestion for the scripts/update-all.sh script to make its behavior more aligned with its name by including the nix flake update command.

[gemini-code-assist]

The script is named update-all.sh, which implies it updates everything. However, it doesn't update the flake inputs (via nix flake update), which can be misleading. To make the script's behavior match its name and provide a more complete update workflow, consider including the flake update command. This will ensure your flake's dependencies are updated before rebuilding the system.

Suggested change

	sudo sh -c 'nix --option extra-access-tokens "github.com=${1}" run nix-darwin -- switch --flake .#Mac' sh "${GITHUB_TOKEN}"
	sh -c 'nix --option extra-access-tokens "github.com=${1}" flake update' sh "${GITHUB_TOKEN}"
	sudo sh -c 'nix --option extra-access-tokens "github.com=${1}" run nix-darwin -- switch --flake .#Mac' sh "${GITHUB_TOKEN}"