Skip to content

Commit 621f235

Browse files
committed
Add aether-docs skill and external doc folder reference
1 parent eb4765d commit 621f235

2 files changed

Lines changed: 63 additions & 0 deletions

File tree

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: aether-docs
3+
description: >
4+
Use when working in the Aether codebase and you need detailed project
5+
documentation — architecture decisions, design rationale, flow diagrams,
6+
feature specs, ADRs, historical context, WIP drafts. Detailed docs live
7+
OUTSIDE the repo at ~/Documents/bjarne/projects/Aether. Read that folder
8+
before making non-trivial changes, and write new detailed docs there
9+
(never into the git repo's docs/ folder, which is for user-facing docs
10+
only — CLI, installation, custom apps, templates).
11+
---
12+
13+
# Aether detailed documentation
14+
15+
The in-repo docs (`README.md`, `docs/*.md`, `CLAUDE.md`) cover only the minimum needed to build, run, and understand the public feature surface. **Detailed project documentation lives outside the repo** at:
16+
17+
```
18+
~/Documents/bjarne/projects/Aether
19+
```
20+
21+
## When to consult this folder
22+
23+
- Before implementing a non-trivial feature — check for existing design docs, prior decisions, or half-finished drafts on the area you're touching.
24+
- Before architectural changes — look for ADRs or flow diagrams that explain *why* things are structured as they are.
25+
- When the user asks "how does X work" or "why did we build X that way" and the answer isn't obvious from code.
26+
- After a significant design discussion — write a new doc so future work has the context.
27+
28+
## How to use
29+
30+
```bash
31+
ls ~/Documents/bjarne/projects/Aether
32+
rg "<topic>" ~/Documents/bjarne/projects/Aether
33+
```
34+
35+
Read relevant files before drafting a plan. Cite the filename when you rely on one.
36+
37+
## Writing new docs
38+
39+
When the user asks you to document a design decision, flow, or feature internal:
40+
41+
- Write to `~/Documents/bjarne/projects/Aether/<topic>.md`.
42+
- Use a short descriptive filename (e.g. `palette-extraction-pipeline.md`, `eyedropper-loupe-design.md`, `adr-001-split-sidebars.md`).
43+
- Include date headers so the reader can see when something was decided.
44+
45+
**Do not** put these detailed docs into the repo's `docs/` folder — that directory is reserved for user-facing documentation (CLI usage, installation, custom apps, custom templates, wallhaven setup, etc.).
46+
47+
## Do not
48+
49+
- Don't guess at Aether's architecture or history without checking this folder first — the user keeps decisions here rather than in commit messages or PR descriptions.
50+
- Don't duplicate content from here into the repo.
51+
- Don't commit anything to git from this folder — it's deliberately outside version control.

CLAUDE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
Desktop theming app. **Wails 2** (Go backend) + **Svelte 5** frontend (TypeScript, Tailwind v4). Extracts color palettes from wallpapers and applies cohesive themes across a Linux desktop (Omarchy-friendly, works standalone).
44

5+
## Detailed project docs (outside the repo)
6+
7+
Architecture decisions, design rationale, flow diagrams, ADRs, feature specs, and historical context live at:
8+
9+
```
10+
~/Documents/bjarne/projects/Aether
11+
```
12+
13+
**Read that folder** before making non-trivial changes or when the user asks "how does X work". **Write new detailed docs there** — the repo's `docs/` folder is reserved for user-facing documentation (CLI, installation, custom apps, templates). Content in `~/Documents/bjarne/projects/Aether` is deliberately outside git.
14+
15+
See the `aether-docs` skill (`.claude/skills/aether-docs/SKILL.md`) for the full convention.
16+
517
## Commands
618

719
From repo root (requires Go + `wails` CLI + Node):

0 commit comments

Comments
 (0)