diff options
Diffstat (limited to 'AGENTS.md')
| -rw-r--r-- | AGENTS.md | 13 |
1 files changed, 10 insertions, 3 deletions
@@ -6,13 +6,18 @@ This repository is for the creation and maintenance of Emacs 30 configuration fi ## Repository Layout -- `config.org` is the single hand-edited source of truth for the configuration. +- `config.org` is the single hand-edited source of truth for Emacs configuration. - `init.el` and `early-init.el` are generated from `config.org` and should not be edited directly. - Structure the literate config by startup responsibility first, then by workflow domain. - The current Org workflow lives under `~/org/` with `daily/`, `projects/`, `areas/`, `areas/people/people.org`, `resources/`, and `archives/`. +- `~/org/` is external to this repository and must already exist. +- The configuration may open files in `~/org/`, but it must not create directories, create files, or validate note structure. +- `~/org/moc.org` is a normal note. The configuration may open it, but it must not create or manage it. - Daily notes stay as plain Org files under `~/org/daily/`; longer-lived notes are handled through Denote in the same root. -- Agenda files are discovered dynamically from the project, area, and resource directories rather than from a fixed file list. -- The config also includes a small gptel workflow that uses GitHub Copilot as the backend. +- Agenda files are discovered by recursively scanning `.org` files under `~/org/projects/`, `~/org/areas/`, and `~/org/resources/`. +- Agenda discovery must exclude `~/org/daily/` and `~/org/archives/`. +- PARA is the organising model for durable notes, and folder placement carries meaning. +- The config includes an experimental `gptel` setup that uses GitHub Copilot as the backend. - Do not treat `auto-save-list/` as source content. ## Editing Expectations @@ -47,6 +52,8 @@ This repository is for the creation and maintenance of Emacs 30 configuration fi - Document non-obvious conventions close to the relevant configuration in `config.org`. - Update `README.md` whenever configuration or workflow changes alter package usage, startup behavior, keybindings, directory layout, capture flow, or other documented behavior. - `README.md` must describe the current configuration truthfully. Do not leave stale documentation behind and do not document planned behavior as current behavior. +- Keep README and AGENTS consistent. State rules explicitly and avoid hidden or heuristic behavior in documentation. +- Use `~/org` consistently when describing the external notes directory. - Before claiming a change is complete or asking to commit it, review whether `README.md` needs an update; if it does not, say so explicitly in the summary. - Update AGENTS.md when the repo workflow, Org layout, or verification expectations materially change. - Keep AGENTS.md concise and update it only when the repository structure or working rules actually change. |