Skip to content

Commit 9732356

Browse files
Update common files (#618)
1 parent 63313d9 commit 9732356

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

.agents/skills/docs/SKILL.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ Preferred mapping:
7979
Guardrails:
8080

8181
- Do not handwrite separate Maven/Gradle dependency blocks when `dependency:` is suitable.
82+
- Do not replace Micronaut `snippet::` macros with direct Asciidoctor `[source]` includes or pasted code blocks just because the current examples have one language. The macro is the multi-language, source-backed contract for generated module docs.
83+
- Do not remove snippet callouts when touching examples. Preserve existing callout tags and callout explanations unless the underlying executable source no longer has that behavior.
8284
- Do not duplicate configuration property tables manually when generated references exist.
8385
- Keep environment-sensitive instructions explicit (for example `MICRONAUT_ENVIRONMENTS=dev`).
8486
- Prefer stable links to official Micronaut docs for endpoint semantics.
@@ -122,6 +124,7 @@ When finishing docs work, report:
122124

123125
- [ ] `toc.yml` and `.adoc` changes are consistent.
124126
- [ ] Macros and includes follow Micronaut maintainer conventions.
127+
- [ ] Existing `snippet::` macros and callouts are preserved unless executable source changes require a different tagged snippet.
125128
- [ ] `publishGuide` and `docs` executed successfully.
126129
- [ ] Output and navigation verified under `build/docs/`.
127130
- [ ] Guidance remains maintainer-focused (not generic app docs).

.agents/skills/docs/references/micronaut-docs-providers.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ Maintainer guidance:
6060

6161
- Use for examples that should stay aligned with source/test files.
6262
- Prefer tagged snippets for stable, focused excerpts.
63+
- Preserve `snippet::` macros even when a repository currently has only one language under `doc-examples/`. The macro is still the docs contract for language-aware rendering and lets the same guide continue to support future Java, Kotlin, or Groovy examples without rewriting the guide.
64+
- Preserve callouts attached to snippet excerpts. Callouts are part of the tutorial explanation, not disposable rendering decoration; remove them only when the referenced executable source behavior is removed or the callout is replaced with an equivalent source-backed explanation.
65+
- Do not convert snippet output to raw `[source,<language>]` blocks, `include::` of generated source, or pasted code as a cleanup shortcut.
6366

6467
## 5) `[configuration]` block processor
6568

0 commit comments

Comments
 (0)