Skip to content

docs: Add index page with repository philosophy and structure - #88

Draft
alycda wants to merge 1 commit into
mainfrom
claude/docs-index-adaptation-wamt9e
Draft

docs: Add index page with repository philosophy and structure#88
alycda wants to merge 1 commit into
mainfrom
claude/docs-index-adaptation-wamt9e

Conversation

@alycda

@alycda alycda commented Aug 5, 2026

Copy link
Copy Markdown
Owner

Summary

Add a comprehensive index page (docs/index.md) that introduces the repository's philosophy, structure, and reading order. This serves as the entry point for both humans and agents exploring the dotfiles project.

Key Changes

  • New file: docs/index.md with Jekyll front matter (title, tagline)
  • Repository thesis: Documents the three core axioms:
    • Axiom i: The commit is the unit (history as artifact)
    • Axiom ii: Declared beats installed (flake-driven reproducibility)
    • Axiom iii: The messy middle is the content (documented solutions)
  • Structure overview: Describes the four main components:
    • One flake for every machine (nix-darwin + Home Manager)
    • Multi-arch dev container (x86_64 + arm64)
    • Declarative agent tooling (Claude Code rules, skills.sh)
    • Knowledge store (docs/solutions/, CONCEPTS.md)
  • Reading order: Guides both humans and agents through README → CLAUDE.md → CONCEPTS.md → docs/solutions/
  • Colophon: Personal note from Alyssa Evans with contact information

Implementation Details

The page emphasizes that this repository documents a learning journey with Nix, not just a final configuration. It positions the commit history and documented solutions as first-class artifacts, aligning with the repository's philosophy of making the "messy middle" valuable through documentation.

Links throughout point to key files and directories in the repository, making it a navigational hub for exploring the project.

https://claude.ai/code/session_01TZuXctAze1wC3nEeWCjSig

Adapts the Ataraxy Labs index.md pattern (frontmatter tagline, one-line
positioning, thesis with three axioms, four live things, colophon,
contact) — the same skeleton used for the personal 'Alyssa Evans — Index'
page — down one more level, from company to person to repository.

The lineage of the opening line drives the adaptation:
- 'Software, written for the things that read it' (Ataraxy Labs)
- 'Code, written for the people who inherit it' (personal index)
- 'Configuration, written for the machines that rebuild it' (this repo)

Axioms map to what the repo actually practices:
- i  'The commit is the unit' — history-as-artifact, jj workflow
- ii 'Declared beats installed' — shared core-packages list, flakes
- iii 'The messy middle is the content' — inherited verbatim from the
  personal index; docs/solutions/ is the proof

Links use absolute GitHub URLs for root files so the page survives
being published from docs/ as a site root (where ../README.md would
break), and the Jekyll-compatible frontmatter means GitHub Pages
'deploy from /docs' renders it as-is.
@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

⊕ Entity-level changes

docs/index.md

Status Type Name
+ preamble (preamble)
+ heading dotfiles
+ heading Thesis
+ heading Axiom i — The commit is the unit.
+ heading Axiom ii — Declared beats installed.
+ heading Axiom iii — The messy middle is the content.
+ heading Inside
+ heading Reading order
+ heading Colophon
+ heading Contact

Summary: 10 added across 1 file

functions and classes, not lines · sem

Comment thread docs/index.md

## Colophon

This was supposed to be a weekend of configuration. It became a curriculum. The bee shouldn't fly, and does.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This was supposed to be a weekend of configuration. It became a curriculum. The bee shouldn't fly, and does.
This was supposed to be a weekend of configuration. It became a curriculum. The bee shouldn't fly, and yet, it _does_.

Comment thread docs/index.md

## 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.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.
For humans and agents alike: [README](../README.md) for the map, [CLAUDE.md](../CLAUDE.md) for the conventions, [CONCEPTS.md](../CONCEPTS.md) for the vocabulary, [docs/solutions/](.//solutions) for the scars.

Comment thread docs/index.md
@@ -0,0 +1,49 @@
---
title: "dotfiles — Index"
tagline: "The Messy Middle, Reproducible"

Copy link
Copy Markdown
Owner Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants