Skip to content

Finish the org flake standard: AGENTS.md and .gitignore #7

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.

Sign up for GitHub

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

Merged
andrewthomaslee merged 1 commit into from
Nov 3, 2026
Merged

Finish the org flake standard: AGENTS.md and .gitignore #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Build artifacts are NEVER committed. CI builds the site and deploys it
# to GitHub Pages (.github/workflows/pages.yml); see CLAUDE.md.
# to GitHub Pages (.github/workflows/ci.yml, the org CI); see AGENTS.md.

# nix build output links
result
result-*

# devenv
.devenv*
.direnv
devenv.local.nix

# `mkdocs build` output, if you ever run mkdocs outside Nix
Expand Down
5 changes: 4 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ builds its own docs and deck with the same module.
- `dev/flake.nix` + `dev/flake.lock`: dev-only inputs. `dev/flake-module.nix`: the dev partition (formatter, checks, this repo's docs and deck).
- `devenv.yaml` + `devenv.lock` + `devenv.nix`: the dev shell. The org shell comes from external-systems/pkgs (`org-pkgs/devenv` in devenv.yaml).
- `documentation/`: `flake-module.nix`, MkDocs site (`mkdocs.yml`, `docs/`) and reveal.js deck (`slides/`).
- `.github/workflows/ci.yml`: the org CI, calling external-systems/pkgs `org-ci.yml` (`nix flake check` on PRs as `ci / flake-check`; Pages deploy and `0.<minor>.<commits>` release on main). `.github/rulesets/default.json`: the org branch ruleset. Change CI only in pkgs, never here.
- `.vscode/`: nixd settings, resolved from this flake's own inputs and `debug` options.

## Tool loop
- The shell is devenv. If `DEVENV_ROOT` is unset, run commands with `devenv shell -- <cmd>`.
Expand All @@ -24,4 +26,5 @@ builds its own docs and deck with the same module.
- Load the `nix-style` skill before editing any `.nix` file, and `mkdocs-reveal` before changing the exports.
- Dev-only inputs go in `dev/flake.nix`, never `flake.nix`.
- Never change the shape of `lib`, `flakeModules` or `templates` without updating every consumer (pkgs template, skills, secrets, not-secrets, modules, home, clanServices).
- Work on a branch and open a PR. Never push to `main`.
- Work on a branch and open a PR. Never push to `main`; the ruleset requires a PR with a green `ci / flake-check`.
- Never commit build output (`result*`, `_site/`, `site/`, `documentation/site/`): docs and slides are built and deployed by CI.
Loading