Skip to content

AGENTS.md

Latest commit

 

History

History
61 lines (47 loc) · 2.64 KB

AGENTS.md

File metadata and controls

61 lines (47 loc) · 2.64 KB
Raw

AGENTS.md

This file is for AI coding agents (Claude Code, Codex, Cursor, etc.) and humans working in this repository. It is the agent-agnostic source of truth; Claude Code loads it via the @AGENTS.md import in CLAUDE.md.

What this repo is

pyautolabs.github.io is the PyAuto front door — a single static hub that links the documentation, example workspaces, tutorial courses and AI-assistant path for the PyAuto software stack (PyAutoFit, PyAutoGalaxy, PyAutoLens). It is served by GitHub Pages at https://pyautolabs.github.io.

It is the cross-project landing layer only. Per-project documentation stays on ReadTheDocs (the canonical URLs); this site links out to it rather than duplicating it.

Layout

  • index.html — the entire site. Self-contained: no external assets, no build step, no framework. Light/dark is handled via prefers-color-scheme.
  • RETROFIT.md — how to move this hub and the docs onto paid custom domains later; the site intentionally runs on free infrastructure today.
  • README.md — this repo's own short summary.

Working here

  • No build step. Edit index.html directly and open it in a browser to preview. GitHub Pages serves it as-is when the default branch is pushed.
  • Keep it self-contained. Do not add external scripts, stylesheets, fonts or images — inline everything so the page has no runtime dependencies.
  • Landing layer only. Link out to ReadTheDocs and the workspace/tutorial repos; don't copy per-project documentation into this site.
  • Support light and dark via prefers-color-scheme, matching the existing page.

Never rewrite history

NEVER perform these operations on any repo with a remote:

  • git init in a directory already tracked by git
  • rm -rf .git && git init
  • Commit with subject "Initial commit", "Fresh start", "Start fresh", "Reset for AI workflow", or any equivalent message on a branch with a remote
  • git push --force to main (or any branch tracked as origin/HEAD)
  • git filter-repo / git filter-branch on shared branches
  • git rebase -i rewriting commits already pushed to a shared branch

If the working tree needs a clean state, the only correct sequence is:

git fetch origin
git reset --hard origin/main
git clean -fd

This applies equally to humans, local Claude Code, cloud Claude agents, Codex, and any other agent. The "Initial commit — fresh start for AI workflow" pattern that appeared independently on origin and local for three workspace repos is exactly what this rule prevents — it costs ~40 commits of redundant local work every time it happens.