Skip to content

Commit ce3d761

Browse files
committed
docs(ai-coders): wire cross-links from CONTRIBUTING.md + AGENTS.md + toctree
1 parent 417342b commit ce3d761

3 files changed

Lines changed: 5 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ description: Vendor-neutral rules for AI coding agents working on EMHASS source.
77

88
This file documents rules for AI coding agents (Claude Code, Cursor, Aider, Copilot, Codex) working on EMHASS source. It complements `docs/develop.md` (canonical for humans) and does not duplicate its content. Where `docs/develop.md` already covers a topic, this file links and adds AI-specific constraints on top.
99

10+
*Humans driving an agent on this codebase: see [`docs/develop_ai_coders.md`](docs/develop_ai_coders.md) for the contributor-side companion to this file.*
11+
1012
## Repository layout
1113

1214
- `src/emhass/` — core module: `optimization.py`, `forecast.py`, `retrieve_hass.py`, `web_server.py`, `command_line.py`, `utils.py`.

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,5 @@
33
Pull requests are very much accepted on this project. For development, you can find some instructions here [Development](https://emhass.readthedocs.io/en/latest/develop.html).
44

55
For AI coding agents working on EMHASS source, see [`AGENTS.md`](AGENTS.md).
6+
7+
Driving an AI coding agent on this codebase? See [`docs/develop_ai_coders.md`](docs/develop_ai_coders.md) for human-side guidance.

docs/section_reference.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@
44
:maxdepth: 2
55
emhass
66
develop
7+
develop_ai_coders
78
```

0 commit comments

Comments
 (0)