fix: Address documentation issues - #425
Open
elharo wants to merge 7 commits into
Open
Conversation
Updated wording for clarity and consistency in the explanation of generating a generic POM.
There was a problem hiding this comment.
Pull request overview
This pull request updates the Maven Install Plugin’s Maven Site documentation sources to correct rendering/formatting problems and improve wording in usage and example pages.
Changes:
- Normalizes APT page header formatting across multiple site pages.
- Improves inline markup and wording in usage/examples to render correctly in the generated site.
- Adds/adjusts small documentation metadata in the FAQ source.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/site/fml/faq.fml | Adjusts the FML FAQ header comment metadata. |
| src/site/apt/usage.apt | Fixes usage page markup and a parameter example formatting. |
| src/site/apt/index.apt.vm | Updates introduction page header formatting and inline markup. |
| src/site/apt/examples/specific-local-repo.apt.vm | Normalizes example page header formatting. |
| src/site/apt/examples/installing-secondary-artifacts.apt.vm | Fixes an example command line formatting issue. |
| src/site/apt/examples/generic-pom-generation.apt.vm | Rewords and reformats the “generic POM generation” example text. |
| src/site/apt/examples/custom-pom-installation.apt.vm | Normalizes example page header formatting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes multiple documentation issues in the maven-install-plugin repository: