Fixed developer guide warnings from vale and cleaned up#4740
Merged
shai-almog merged 17 commits intomasterfrom Apr 12, 2026
Merged
Fixed developer guide warnings from vale and cleaned up#4740shai-almog merged 17 commits intomasterfrom
shai-almog merged 17 commits intomasterfrom
Conversation
Contributor
|
Developer Guide build artifacts are available for download from this workflow run:
Developer Guide quality checks: |
Contributor
✅ Continuous Quality ReportTest & Coverage
Static Analysis
Generated automatically by the PR CI workflow. |
5a640d1 to
62c6750
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a reusable “developer-guide-vale” skill to run Vale locally in a CI-matching way, and applies a broad set of copy/style edits across the Developer Guide to address lint warnings (Vale/AsciiDoc) and improve consistency.
Changes:
- Added a Vale-running skill (commands + agent metadata) that mirrors
.github/workflows/developer-guide-docs.yml. - Updated many Developer Guide chapters to adjust wording, punctuation, and formatting aimed at reducing Vale alerts.
- Performed additional editorial cleanup across Maven appendix/goal docs and other guide sections.
Reviewed changes
Copilot reviewed 46 out of 55 changed files in this pull request and generated 19 comments.
Show a summary per file
| File | Description |
|---|---|
| skills/developer-guide-vale/SKILL.md | Documents CI-matching Vale install/sync/run + report generation steps. |
| skills/developer-guide-vale/agents/openai.yaml | Registers the skill for the OpenAI agent interface. |
| docs/developer-guide/Working-with-UWP.asciidoc | Minor wording updates about UWP deprecation. |
| docs/developer-guide/Working-With-The-GUI-Builder.asciidoc | Editorial changes to GUI Builder troubleshooting and guidance text. |
| docs/developer-guide/Working-with-Mac-OS-X.asciidoc | Editorial and formatting updates to Mac desktop signing/bundling docs. |
| docs/developer-guide/Working-With-iOS.asciidoc | Wording updates across troubleshooting, launch screen, CocoaPods/SPM sections. |
| docs/developer-guide/Working-With-CodenameOne-Sources.asciidoc | Minor copy edits to prerequisites and next steps. |
| docs/developer-guide/Video-Capture-Constraints.asciidoc | Punctuation/formatting cleanup and table formatting changes. |
| docs/developer-guide/Theme-Basics.asciidoc | Broad editorial updates to theme basics/tutorial narrative. |
| docs/developer-guide/The-EDT---Event-Dispatch-Thread.asciidoc | Wording tweaks around EDT usage and helper methods. |
| docs/developer-guide/signing.asciidoc | Copy edits in iOS/Android signing explanations and wizard steps. |
| docs/developer-guide/security.asciidoc | Copy edits and phrasing adjustments in security guidance. |
| docs/developer-guide/performance.asciidoc | Copy edits and small updates in performance guidance and ParparVM hints. |
| docs/developer-guide/Maven-Updating-Codename-One.adoc | Minor copy edits for update guidance. |
| docs/developer-guide/Maven-Project-Templates.adoc | Editorial tweaks for template creation instructions. |
| docs/developer-guide/Maven-Getting-Started.adoc | Editorial tweaks in getting started and migration instructions. |
| docs/developer-guide/Maven-Creating-CN1Libs.adoc | Copy edits and formatting tweaks in CN1Lib creation docs. |
| docs/developer-guide/Maven-Appendix-Rich-Properties.adoc | Minor wording cleanup in RPF format appendix. |
| docs/developer-guide/Maven-Appendix-Control-Center.adoc | Minor wording cleanup in Control Center appendix. |
| docs/developer-guide/Maven-Appendix-Archetypes.adoc | Minor wording cleanup in archetypes appendix. |
| docs/developer-guide/Maven-Appendix-API.adoc | Copy edits in API appendix (Java SE wording, notes). |
| docs/developer-guide/Events.asciidoc | Editorial changes to event system explanations/headings. |
| docs/developer-guide/component-selector.asciidoc | Copy edits and formatting tweaks in ComponentSelector guide. |
| docs/developer-guide/Casual-Game-Programming.asciidoc | Editorial changes to narrative voice and punctuation. |
| docs/developer-guide/appendix_goal-cn1lib.adoc | Minor copy edits for cn1lib goal appendix entry. |
| docs/developer-guide/appendix_goal_update.adoc | Minor copy edits for update goal appendix entry. |
| docs/developer-guide/appendix_goal_test.adoc | Minor copy edits for test goal appendix entry. |
| docs/developer-guide/appendix_goal_prepare_simulator_classpath.adoc | Minor copy edits (Java SE module naming). |
| docs/developer-guide/appendix_goal_install_codenameone.adoc | Minor copy edits for install-codenameone goal entry. |
| docs/developer-guide/appendix_goal_install_cn1lib.adoc | Minor copy edits for install-cn1lib goal entry. |
| docs/developer-guide/appendix_goal_guibuilder.adoc | Minor copy edits for guibuilder goal entry. |
| docs/developer-guide/appendix_goal_generate_native_interfaces.adoc | Minor copy edits + Java SE module path naming. |
| docs/developer-guide/appendix_goal_generate_gui_sources.adoc | Minor copy edits for generate-gui-sources goal entry. |
| docs/developer-guide/appendix_goal_generate_desktop_app_wrapper.adoc | Minor copy edits + Java SE naming. |
| docs/developer-guide/appendix_goal_generate_cn1lib_project.adoc | Minor copy edits in Ant→Maven cn1lib migration goal entry. |
| docs/developer-guide/appendix_goal_generate_archetype.adoc | Copy edits and formatting changes in unused goal appendix entry. |
| docs/developer-guide/appendix_goal_generate_app_project.adoc | Copy edits and clarifications in generate-app-project entry. |
| docs/developer-guide/appendix_goal_css.adoc | Minor copy edit for css goal entry. |
| docs/developer-guide/appendix_goal_create_gui_form.adoc | Minor copy edits in create-gui-form goal entry. |
| docs/developer-guide/appendix_goal_clone.adoc | Minor copy edits for clone goal entry. |
| docs/developer-guide/appendix_goal_build.adoc | Copy edits + Java SE/Gradle wording changes in build goal entry. |
| docs/developer-guide/Animations.asciidoc | Copy edits and wording adjustments in animations chapter. |
| docs/developer-guide/About-This-Guide.asciidoc | Editorial updates to contribution/licensing/conventions preface. |
💡 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> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Shai Almog <67850168+shai-almog@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.
No description provided.