-
Notifications
You must be signed in to change notification settings - Fork 0
docs: Add index page with repository philosophy and structure #88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
alycda
wants to merge
1
commit into
main
Choose a base branch
from
claude/docs-index-adaptation-wamt9e
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+49
−0
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,49 @@ | ||||||
| --- | ||||||
| title: "dotfiles — Index" | ||||||
| tagline: "The Messy Middle, Reproducible" | ||||||
| --- | ||||||
|
|
||||||
| # dotfiles | ||||||
|
|
||||||
| Configuration, written for the machines that rebuild it (and the person who reads the history) | ||||||
|
|
||||||
| Flake-based declarative environments: nix-darwin + Home Manager, one `flake.nix` driving a work Mac, personal profiles, and a headless dev container — reproducible from zero. This repository documents a learning journey with Nix, not just a final configuration. | ||||||
|
|
||||||
| ## Thesis | ||||||
|
|
||||||
| Most dotfiles show you the destination. This repo keeps the journey: every wrong turn committed, every fix documented, every state rebuildable. | ||||||
|
|
||||||
| ### Axiom i — The commit is the unit. | ||||||
|
|
||||||
| The history is the artifact. Incremental, meaningful commits over squashes — a commit that explains *why* teaches more than a diff that shows *what*. Jujutsu (`jj`) makes history something you shape deliberately, not something that happens to you. | ||||||
|
|
||||||
| ### Axiom ii — Declared beats installed. | ||||||
|
|
||||||
| If it isn't in the flake, it doesn't exist. One shared package list feeds both the ephemeral `nix develop` shell and the persistent home environment, so a throwaway sandbox and a switched profile behave identically. New machine, new container: same environment, from zero. | ||||||
|
|
||||||
| ### Axiom iii — The messy middle is the content. | ||||||
|
|
||||||
| The axiom this repo exists to prove. Nothing is wasted when you document it: [`docs/solutions/`](https://github.com/alycda/dotfiles/tree/main/docs/solutions) holds the write-up for every package collision, lint trap, and activation failure — each hit once, documented once, never re-debugged. | ||||||
|
|
||||||
| ## Inside | ||||||
|
|
||||||
| Four things, all live: | ||||||
|
|
||||||
| - **One flake, every machine** — nix-darwin system config plus Home Manager profiles for work, home, and code contexts, composed from small focused modules. [flake.nix](https://github.com/alycda/dotfiles/blob/main/flake.nix) | ||||||
| - **A multi-arch dev container** — x86_64 + arm64 image with the home-manager generation baked in; the entrypoint reconciles the baked generation against a persistent home volume on every start. [Dockerfile](https://github.com/alycda/dotfiles/blob/main/Dockerfile) | ||||||
| - **Declarative agent tooling** — Claude Code rules, an agent-instruction overlay, and skills.sh skills pinned through nix-skills — reading per-letter index shards instead of forcing a 48MB overlay evaluation. [lib/skills-sh.nix](https://github.com/alycda/dotfiles/blob/main/lib/skills-sh.nix) | ||||||
| - **A knowledge store** — [`docs/solutions/`](https://github.com/alycda/dotfiles/tree/main/docs/solutions) for documented failures with structured frontmatter, [`CONCEPTS.md`](https://github.com/alycda/dotfiles/blob/main/CONCEPTS.md) for shared domain vocabulary. The part the agents read first. | ||||||
|
|
||||||
| ## Reading order | ||||||
|
|
||||||
| For humans and agents alike: [README](https://github.com/alycda/dotfiles/blob/main/README.md) for the map, [CLAUDE.md](https://github.com/alycda/dotfiles/blob/main/CLAUDE.md) for the conventions, [CONCEPTS.md](https://github.com/alycda/dotfiles/blob/main/CONCEPTS.md) for the vocabulary, [docs/solutions/](https://github.com/alycda/dotfiles/tree/main/docs/solutions) for the scars. | ||||||
|
Owner
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| ## Colophon | ||||||
|
|
||||||
| This was supposed to be a weekend of configuration. It became a curriculum. The bee shouldn't fly, and does. | ||||||
|
Owner
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| — Alyssa Evans | ||||||
|
|
||||||
| ## Contact | ||||||
|
|
||||||
| alyda@me.com · https://github.com/alycda/dotfiles · Los Angeles, CA | ||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the journey is the destination