Skip to content

[serialization] Update common files for branch 3.1.x #1344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
micronaut-build wants to merge 1 commit into
base: 3.1.x
Choose a base branch
from
+6 −0
Open

[serialization] Update common files for branch 3.1.x #1344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .agents/skills/docs/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ Preferred mapping:
Guardrails:

- Do not handwrite separate Maven/Gradle dependency blocks when `dependency:` is suitable.
- 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.
- 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.
- Do not duplicate configuration property tables manually when generated references exist.
- Keep environment-sensitive instructions explicit (for example `MICRONAUT_ENVIRONMENTS=dev`).
- Prefer stable links to official Micronaut docs for endpoint semantics.
Expand Down Expand Up @@ -122,6 +124,7 @@ When finishing docs work, report:

- [ ] `toc.yml` and `.adoc` changes are consistent.
- [ ] Macros and includes follow Micronaut maintainer conventions.
- [ ] Existing `snippet::` macros and callouts are preserved unless executable source changes require a different tagged snippet.
- [ ] `publishGuide` and `docs` executed successfully.
- [ ] Output and navigation verified under `build/docs/`.
- [ ] Guidance remains maintainer-focused (not generic app docs).
Expand Down
3 changes: 3 additions & 0 deletions .agents/skills/docs/references/micronaut-docs-providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ Maintainer guidance:

- Use for examples that should stay aligned with source/test files.
- Prefer tagged snippets for stable, focused excerpts.
- 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.
- 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.
- Do not convert snippet output to raw `[source,<language>]` blocks, `include::` of generated source, or pasted code as a cleanup shortcut.

## 5) `[configuration]` block processor

Expand Down
Loading