Repository navigation
docs: instruct agents to never run 'make -C docs' - #636
Conversation
Co-authored-by: Imani Pelton <imani.pelton@canonical.com>
There was a problem hiding this comment.
🟢 Approval recommended
No blocking issues were identified; remaining feedback is limited to minor command-naming clarification.
3 open findings
What changed in this PR
Updates agent guidance to avoid make -C docs, preventing creation of a conflicting documentation virtual environment.
Changes:
- Warns against direct documentation subdirectory builds.
- Directs agents to top-level documentation targets.
- Applies guidance across all agent instruction files.
| File | Summary |
|---|---|
AGENTS.md |
Updated documentation build guidance |
AGENTS.lib.md |
Updated library agent guidance |
AGENTS.app.md |
Updated application agent guidance |
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Review notes on the new agent instruction:
|
- Refer to top-level documentation targets rather than the docs-* pattern, and include setup-docs and docs (Copilot) - Forbid running make from within docs/ as well as -C docs (LoweRAM) - Add docs-linkcheck, docs-spelling, and docs-woke examples (LoweRAM) - Note the rule applies to agent-run commands only (LoweRAM) Co-authored-by: Imani Pelton <imani.pelton@canonical.com>
|
🤖 [GENERATED BY A TOASTER -- kimi-k3] Thanks for the review — all three points addressed in dbf19af:
|
Avoids maintaining an explicit list of documentation targets in the agent instructions, which would drift out of sync with the Makefile. Co-authored-by: Imani Pelton <imani.pelton@canonical.com>
|
🤖 [GENERATED BY A TOASTER -- kimi-k3] Replaced the explicit target list with a pointer to |
'make help' omits pattern-rule passthroughs like docs-linkcheck, and 'make docs-help' lists the unprefixed subproject commands. Note the docs- prefix mapping so agents don't fall back to running Make inside docs/. Co-authored-by: Imani Pelton <imani.pelton@canonical.com>
Co-authored-by: Imani Pelton <imani.pelton@canonical.com>
|
Potential agent misinterpretations:
|
The AGENTS.md rule now bans running the docs Makefile directly in any form, states why, and notes the carve-out for the repo's own targets and hooks. The docs-help footer no longer instructs readers to run make from inside docs/, which contradicted the rule and the purpose of the docs-% passthrough introduced in e94f190. Co-authored-by: Imani Pelton <imani.pelton@canonical.com>
Co-authored-by: Imani Pelton <imani.pelton@canonical.com>
mr-cal
left a comment
There was a problem hiding this comment.
Nice, thanks!
As an aside, I hold almost no value in agent opnions on the contents of an agents file.

🤖 GENERATED BY A TOASTER -- kimi-k3
Agents will often attempt
make -C docs, which misses the redefinition ofDOCS_VENVDIRincommon.mkand creates a secondary venv that confuses much of our tooling.