docs: route cn1lib creation through the Maven cn1lib-archetype#4952
Merged
Conversation
Advanced-Topics-Under-The-Hood still walked readers through the old
NetBeans/Eclipse plugin wizard ("Select the CodenameOne Library Option"
screenshots) and the Ant `Refresh cn1lib files` flow for installing
libraries. New projects use Maven, and the canonical library-creation
guide already lives in Maven-Creating-CN1Libs.adoc — so this section
now leads with the `cn1lib-archetype` + pom-dependency workflow and
keeps the Ant instructions only as a clearly-labelled legacy sidebar.
Also removes the orphaned cn1lib-create-step{1,2}.png screenshots that
were tied to the old wizard.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Developer Guide build artifacts are available for download from this workflow run:
Developer Guide quality checks:
Unused image preview:
|
Contributor
Cloudflare Preview
|
shai-almog
added a commit
that referenced
this pull request
May 16, 2026
Splits the find_unused_images.py check into a real quality gate: - ignore non-image files in the image tree so .gitkeep placeholders no longer flash as orphans - exit non-zero when at least one unused image is found so the new quality-gate step at the end of the developer-guide workflow can fail the build with the other linters Also removes docs/developer-guide/img/cn1libs-refresh.png, which was orphaned by #4952 when the matching image:: directive was deleted alongside the other cn1lib screenshots. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
shai-almog
added a commit
that referenced
this pull request
May 17, 2026
* Treat developer guide vale and asciidoc warnings as build errors Drives the docs/developer-guide vale report to zero findings at every severity level, then promotes any future vale/asciidoctor warning to a build-breaking failure in the Build Developer Guide Docs workflow. Fixes are split between real prose corrections (heading colon capitalization, stale "e.g." / "E.g." rewrites, British → American spelling, punctuation inside quotes, broken pre-existing prose) and documented rule disables in docs/developer-guide/.vale.ini covering default checks that misfire systematically on a long-form developer guide (passive voice, sentence length, acronym definitions, the "disabled" accessibility flag, etc.). The styles directory remains gitignored, with an exception that tracks the project vocabulary so CI sees the same accept list as local contributors. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Treat unused developer guide images as a build-breaking warning Splits the find_unused_images.py check into a real quality gate: - ignore non-image files in the image tree so .gitkeep placeholders no longer flash as orphans - exit non-zero when at least one unused image is found so the new quality-gate step at the end of the developer-guide workflow can fail the build with the other linters Also removes docs/developer-guide/img/cn1libs-refresh.png, which was orphaned by #4952 when the matching image:: directive was deleted alongside the other cn1lib screenshots. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Re-enable vale rules disabled too aggressively and fix the findings Critically re-examines each previously-disabled vale rule and keeps only the ones whose recommendation is *wrong* for a developer-facing reference, with a written rationale for each. The rest are now back on as build-failing checks and the existing prose has been rewritten to match. Real defects that the re-enabled rules caught and that the prose now fixes: - write-good.Illusions found "IntelliJ IDEA IDEA" and "Eclipse IDE IDE" (the kind of LLM-generated repetition we want to keep catching). - write-good.ThereIs cleared 44 "There is..." / "There are..." sentence openers in favour of stronger verb phrases. - Microsoft.FirstPerson / Microsoft.We replaced ~190 instances of authorial "I", "we", and "let's" with second-person or imperative voice consistent with the rest of the guide. - Microsoft.Contractions normalised 70+ "they are" / "is not" / "what is" forms to the contractions the rule prefers (and fixed a real "where is says" typo on Push-Notifications.asciidoc). - Microsoft.Adverbs cut about 40 redundant softeners; the remaining precise adverbs (`lazily` on `LazyValue`, `gracefully` on fallback degradation, etc.) carry per-line vale-skip rationale. - Microsoft.Auto switched generic "auto-X" hyphenations to the unhyphenated Microsoft form, while keeping Apple/Google product terms ("Auto-Renewable subscriptions") behind per-line skips. - Microsoft.OxfordComma, Microsoft.Wordiness, Microsoft.Percentages, proselint.Skunked, and write-good.So were each driven to zero by rewrites. - proselint.Needless additions to the project Vocab keep Android's "Lollipop" codename and "extensible" / "oversized" from being spell-corrected to "lollypop" / "extendable" / "oversize". Vocab additions cover Java ME / Java SE / Java EE platform names so they no longer trip Microsoft.FirstPerson on the trailing "ME". The rules that remain off carry a paragraph in `.vale.ini` describing *why* their recommendation is inappropriate for this guide (E-Prime banning "to be", Microsoft.GeneralURL turning "URL" into "address", Microsoft.Spacing firing on dotted code identifiers, Microsoft.Ranges rewriting ISO 639-1 / ISO 3166-1 standard codes, Microsoft.Semicolon firing on Java statement terminators inside `[source,java]` blocks, and so on). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Restore guibuilder-2-smart-insets-auto-snap-checkboxes.png references The bulk "auto-snap" -> "autosnap" rewrite that satisfied Microsoft.Auto in prose accidentally also renamed the image:: target to a path that doesn't exist on disk (the image file is still guibuilder-2-smart-insets-auto-snap-checkboxes.png). That broke both the website's lychee link check and the developer guide workflow's unused-image gate. The image filename is inside an image:: directive that vale's adoc parser excludes from prose, so restoring the hyphen keeps the rule clean while pointing readers at the file that actually ships in img/. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.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
1 participant
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.
Summary
Refresh cn1lib filesflow. Re-route these sections to the Mavencn1lib-archetype+ pom-dependency workflow that already exists inMaven-Creating-CN1Libs.adoc(anchorcreating-cn1libs).cn1lib-create-step1.png,cn1lib-create-step2.png) that were no longer referenced.Test plan
creating-cn1libs/maven-project-workflow.image::img/cn1lib-create-step*.png[]references exist anywhere in the repo.🤖 Generated with Claude Code