Skip to content

docs: add agent skills configuration, GLOSSARY and first ADR - #8841

Closed
fstagni wants to merge 1 commit into
DIRACGrid:integrationfrom
fstagni:docs_agent-skills-config
Closed

fstagni wants to merge 1 commit into
DIRACGrid:integrationfrom
fstagni:docs_agent-skills-config

Conversation

@fstagni

@fstagni fstagni commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the in-repo configuration that engineering AI agents read, plus the first domain artifacts. AGENTS.md keeps the only always-loaded part (three context pointers); the bodies live behind them:

 AGENTS.md
+  ## Agent skills            # 3 pointer lines, nothing else
+docs/agents/
+  ├── issue-tracker.md       # issue conventions for agents (gh CLI)
+  └── domain.md              # glossary/ADR consumer rules
+GLOSSARY.md                  # ~24 core domain terms, verified in code
+docs/adr/
+  └── 0001-agent-config-targets-upstream-tracker.md
  • GLOSSARY.md fixes the project vocabulary agents must reuse (Job vs Pilot vs Payload, Task vs Job vs Task Queue, Site vs Resource vs Element, ...). Definitions were extracted from code and docstrings, not invented; grid acronyms stay in docs/source/UserGuide/glossary.rst (single source of truth).
  • docs/adr/0001 records that agent config is in-repo and that the upstream tracker is the single source of tracked work.

Evidence

  • Before: no shared agent conventions or glossary; each agent session re-derives vocabulary and issue workflow independently.
  • After: every term in GLOSSARY.md was checked against the code (e.g. Site/Resource disjointness verified against ResourceStatusDB tables; Task→Job/Request mapping against WorkflowTaskAgent/RequestTaskAgent). Any agent asked to file an issue reads one file and runs the exact gh commands documented there.

Merge Danger

Door: two-way

Docs-only, additive; reverting is trivial.

Blast radius: agents only — no runtime code, no CI changes.

Deliberately not included: a triage-label vocabulary and the "external PRs as triage surface" flag. Those change tracker behaviour for maintainers (new labels, AI-posted comments on issues) and deserve their own decision; see ADR-0001's consequences.

@fstagni
fstagni force-pushed the docs_agent-skills-config branch from b8f9b00 to e648f41 Compare October 21, 2026 10:20

@aldbr aldbr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the goal here?
Can you prove it would bring any added value to the project? (e.g. consuming less token on average, better accuracy)

I doubt it's useful in its current form + I think it would require some discussions in ddev first.

I am closing the PR, but feel free to open a Feature issue and provide further details.

Thanks

Comment thread docs/agents/domain.md
├── GLOSSARY.md
├── docs/adr/
│ ├── 0001-event-sourced-orders.md
│ └── 0002-postgres-for-write-model.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see any 0002 file

Comment thread docs/agents/domain.md

When your output names a domain concept (in an issue title, a refactor proposal, a hypothesis, a test name), use the term as defined in `GLOSSARY.md`. Don't drift to synonyms the glossary explicitly avoids.

If the concept you need isn't in the glossary yet, that's a signal: either you're inventing language the project doesn't use (reconsider) or there's a real gap (note it for `/domain-modeling`).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is /domain-modeling exactly?

Comment thread docs/agents/domain.md

If your output contradicts an existing ADR, surface it explicitly rather than silently overriding:

> _Contradicts ADR-0007 (event-sourced orders), but worth reopening because…_

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is 0007 exactly?


## Wayfinding operations

Used by `/wayfinder`. The **map** is a single issue with **child** issues as tickets.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is wayfinder?

@aldbr aldbr closed this Oct 21, 2026
@fstagni

fstagni commented Oct 21, 2026

Copy link
Copy Markdown
Contributor Author

The only reason I opened this was for discussing if it would be felt useful to add these types of agents' helpers. I opened this for having a visual reference in a DDev .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants