feat: generate Check docs headlessly via Maven + PDE-free toc/contexts templates - #1364
Draft
joaodinissf wants to merge 4 commits into
Draft
joaodinissf wants to merge 4 commits into
joaodinissf wants to merge 4 commits into
Conversation
joaodinissf
force-pushed
the
check-docs-maven-poc
branch
7 times, most recently
from
May 27, 2026 10:54
f9e0063 to
18bf6cf
Compare
joaodinissf
force-pushed
the
check-docs-maven-poc
branch
from
June 10, 2026 21:31
091a166 to
7492439
Compare
joaodinissf
force-pushed
the
check-docs-maven-poc
branch
from
June 27, 2026 17:12
7492439 to
5a8be3c
Compare
joaodinissf
added a commit
to joaodinissf/dsl-devkit
that referenced
this pull request
Jun 27, 2026
… to Java Convert the two Xtend doc-generation templates this PR touches to plain Java, so dsldevkit#1364 introduces no new Xtend (check.core is mid Xtend->Java migration; 6 of its generators are already Java). Mirrors the xtend-gen StringConcatenation building 1:1, so generated output (docs HTML, toc.xml, contexts.xml) is byte-identical (op-stream verified vs xtend-gen); matches the module's existing migrated generators. Text-block readability coalescing is a separate verified follow-up. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
joaodinissf
force-pushed
the
check-docs-maven-poc
branch
4 times, most recently
from
September 24, 2026 22:03
f152e1a to
c27300b
Compare
…templates An Eclipse application (com.avaloq.tools.ddk.check.core.docApplication) walks a source directory for .check files and writes per-catalog HTML, an index page, and toc.xml/contexts.xml for Eclipse Help. CheckDocumentationTemplates emits the help files as plain strings in the PDE-based IDE builder's layout, without org.eclipse.pde.internal APIs. Output is written with LF line endings on every platform. The walk skips target/ and dot-prefixed directories below the source directory only. Syntax errors, two catalogs sharing a page name, or an empty source tree fail the application without writing anything; pages of removed catalogs are deleted. check.core moves to 17.4.0 for the new exported package. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
compileDoc emits an HTML5 page with inline CSS, severity badges and anchors, and escapes labels and ids. It no longer references the check.css stylesheet in check.runtime.ui, which stays for pages generated by earlier releases. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Compares the templates and the files written by the headless application with copies of check.test.runtime's docs, and covers catalog-level checks, escaping, the source filter and the failure cases. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…uide An opt-in generateCheckDocs profile in check.test.runtime runs the application through tycho-eclipse-plugin:eclipse-run; the regenerated docs snapshot is committed. docs/check-doc-generation.md covers the in-repo flow, documenting another project's catalogs, and Eclipse Help registration. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
joaodinissf
force-pushed
the
check-docs-maven-poc
branch
from
September 26, 2026 08:46
c27300b to
4ea19b9
Compare
This branch has not been deployed
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.
Why the change
Projects that write Check catalogs can now generate the catalogs' HTML documentation and Eclipse Help files in a normal Maven build, without an Eclipse workbench.
Special things to note
toc.xmlandcontexts.xmlthrough PDE. The new templates write exactly the same files, and the test compares them with PDE output. Moving the IDE builder onto the templates is left for a follow-up.check.cssstays incheck.runtime.ui, so pages generated by earlier releases keep their styling.check.coremoves to 17.4.0, because it exports the newcom.avaloq.tools.ddk.check.standalonepackage.Change outline
A new Eclipse application,
com.avaloq.tools.ddk.check.core.docApplication, turns a source folder into adocs/tree. It fails without writing anything when something is wrong:Where the pieces live:
A consuming project adds the profile to its bundle and runs
mvn -PgenerateCheckDocs -DskipTests package. The guide lists the p2 sites theeclipse-runstep needs and shows how to register the Help files. To regenerate this repository's snapshot:🤖 Generated with Claude Code