Skip to content

Fix documentation typos - #1094

Open
elharo wants to merge 2 commits into
masterfrom
fix/doc-issues-1-12
Open

Fix documentation typos#1094
elharo wants to merge 2 commits into
masterfrom
fix/doc-issues-1-12

Conversation

@elharo

@elharo elharo commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Changes

  • index.md:53: Fixed 'describes' -> 'describe' (subject-verb agreement)
  • index.md:61: Fixed 'non-javac compilers' -> 'non-javac compiler'
  • sources.md:49,84: Fixed 'omited' -> 'omitted' (typo)
  • sources.md:57,92: Added missing closing tag in XML examples
  • faq.fml:30: Fixed 'Modello generate' -> 'Modello generates' (grammar)
  • compile-using-different-jdk.md:83: Fixed typo in path /java-11-openjdkk -> /java-11-openjdk
  • site.xml:46: Renamed menu item 'Non-javac compilerIds' -> 'Compile Using a Non-Javac Compiler'
  • site.xml:47: Renamed menu item 'Older projects with module-info' -> 'Java 9+ Projects with module-info'

@elharo elharo changed the title Fix documentation issues 1-12 Fix documentation typos Jul 28, 2026
@elharo elharo added the documentation Improvements or additions to documentation label Jul 28, 2026

Copilot AI left a comment

Copy link
Copy Markdown

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 Compiler Plugin site documentation to correct typos/grammar in multiple pages and to improve the wording of related navigation/link labels.

Changes:

  • Fixes spelling/grammar issues across site markdown and FML content.
  • Corrects XML example snippets in sources.md by closing the <build> tag properly.
  • Renames a site navigation entry for the “non-javac compiler” example (with an additional intended rename noted in the PR description).

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/site/site.xml Updates the Examples menu label for the non-javac compiler page (and should also align the module-info menu label with the PR description).
src/site/markdown/sources.md Fixes “omited” typo and corrects XML example closing </build> tag.
src/site/markdown/index.md Fixes grammar and adjusts link text for the non-javac compiler example.
src/site/markdown/examples/compile-using-different-jdk.md Fixes a typo in the example JDK path.
src/site/fml/faq.fml Fixes grammar in a Modello-related FAQ entry.

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

Comment thread src/site/site.xml
Comment on lines +46 to 47
<item name="Compile Using a Non-Javac Compiler" href="examples/non-javac-compilers.html"/>
<item name="Older projects with module-info" href="examples/module-info.html"/>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants