Skip to content

docs: fix Maven site guide page titles#1678

Open
alvarosanchez wants to merge 1 commit into
5.0.xfrom
DEV-1023-weekly-user-guide-review-micronaut-maven-plugin
Open

docs: fix Maven site guide page titles#1678
alvarosanchez wants to merge 1 commit into
5.0.xfrom
DEV-1023-weekly-user-guide-review-micronaut-maven-plugin

Conversation

@alvarosanchez

Copy link
Copy Markdown
Member

Summary

  • Add document titles to Maven Site AsciiDoc guide pages that previously rendered as [Untitled].
  • Normalize affected section levels so the visible guide hierarchy is preserved under each document title.

Validation

  • Rebased branch cleanly onto origin/5.0.x before publication.
  • Ran ./mvnw -pl micronaut-maven-plugin -am site:site on Java 25; build succeeded.
  • Confirmed no asciidoctor: WARN entries remained in the Maven Site log.
  • Confirmed generated guide pages no longer render [Untitled] titles.

Paperclip subtask: DEV-1023.


✨ This message was AI-generated using gpt-5.5

Copilot AI review requested due to automatic review settings May 26, 2026 23:19

Copilot AI 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.

Pull request overview

This PR updates the Maven Site AsciiDoc guide pages so each page defines a proper document title (preventing [Untitled] in the rendered site) and adjusts section heading levels to preserve the intended hierarchy beneath those titles.

Changes:

  • Add AsciiDoc document titles (= ...) to guide pages that previously started at section-level headings.
  • Re-level headings (==, ===, etc.) so page structure remains consistent under the new document titles.
  • Apply these updates across the affected example pages and the release history page.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file
File Description
micronaut-maven-plugin/src/site/asciidoc/release-history.adoc Adds a proper document title for the Release History page.
micronaut-maven-plugin/src/site/asciidoc/examples/test-resources.adoc Adds page title and normalizes section heading levels for the Test Resources guide.
micronaut-maven-plugin/src/site/asciidoc/examples/run.adoc Adds page title and adjusts headings so sections render correctly under the title.
micronaut-maven-plugin/src/site/asciidoc/examples/package.adoc Adds page title and updates section/subsection levels under the new title.
micronaut-maven-plugin/src/site/asciidoc/examples/openapi.adoc Adds page title and promotes section headings to be under the document title.
micronaut-maven-plugin/src/site/asciidoc/examples/jsonschema.adoc Adds a proper document title for the JSON Schema example page.
micronaut-maven-plugin/src/site/asciidoc/examples/deploy.adoc Adds a proper document title for the Deploy example page.
micronaut-maven-plugin/src/site/asciidoc/examples/bean-import.adoc Adds a proper document title for the Bean Import example page.
micronaut-maven-plugin/src/site/asciidoc/examples/aot.adoc Adds page title and adjusts section headings to align under the document title.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@sonarqubecloud

Copy link
Copy Markdown

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants