Skip to content

test(docs): compile published Java snippets to catch API drift #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DemchaAV merged 2 commits into from
Jun 29, 2026
Merged

test(docs): compile published Java snippets to catch API drift #266

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6ec17e5
test(docs): compile published Java snippets to catch API drift
DemchaAV Jun 29, 2026
f8d9670
test(docs): self-test the snippet guard and tighten its parsing
DemchaAV Jun 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/first-document.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ with a page flow, and render. No coordinates, no manual page breaks.
Open a session for a file path, add one page flow, render. The engine handles
placement and pagination.

<!-- doc-example: id=first-document-smallest mode=method -->
```java
import com.demcha.compose.GraphCompose;
import com.demcha.compose.document.api.DocumentPageSize;
Expand Down Expand Up @@ -41,6 +42,7 @@ modules, sections, paragraphs, lists, tables, and rows are added top to bottom.
The same Flow model scales to a multi-section document. There are still no
coordinates and no manual page breaks — just structure in reading order.

<!-- doc-example: id=first-document-custom mode=method -->
```java
import com.demcha.compose.GraphCompose;
import com.demcha.compose.document.api.DocumentPageSize;
Expand Down
3 changes: 3 additions & 0 deletions docs/templates/business-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ decides file vs stream vs bytes. The caller does.

## Invoice

<!-- doc-example: id=business-invoice mode=method -->
```java
import com.demcha.compose.GraphCompose;
import com.demcha.compose.document.api.DocumentPageSize;
Expand Down Expand Up @@ -86,6 +87,7 @@ Same shape, different spec. Use a proposal when the artifact is sales or
project scope rather than billing. The timeline takes a three-argument
`timelineItem(phase, duration, details)`.

<!-- doc-example: id=business-proposal mode=method -->
```java
import com.demcha.compose.GraphCompose;
import com.demcha.compose.document.api.DocumentPageSize;
Expand Down Expand Up @@ -139,6 +141,7 @@ In production the spec usually comes from application data and the
document is streamed to the caller's stream. The template composes the
same way before any output method; create one session per request.

<!-- doc-example: id=business-stream mode=members -->
```java
import com.demcha.compose.GraphCompose;
import com.demcha.compose.document.api.DocumentSession;
Expand Down
Loading
Loading