Skip to content

Commit dbd3b10

Browse files
committed
docs(engine): fix stale ECS renderer paths after the .ecs split
Follow-up to the legacy ECS PDF renderer split: CONTRIBUTING.md and docs/architecture/overview.md still pointed at the vacated engine.render.pdf.handlers / .helpers locations, and CONTRIBUTING + implementation-guide had broken links to the moved PdfRenderingSystemECSDispatchTest and TableCellBox. Repath to engine.render.pdf.ecs.* and frame the ECS renderer guidance as legacy (canonical PDF output is document.backend.fixed.pdf). Doc-only; guard suite (DocumentationCoverageTest, CanonicalSurfaceGuardTest, DocumentationExamplesTest, PDF boundary guards) green. Surfaced by an independent review of the package-split PR.
1 parent b03a0e4 commit dbd3b10

3 files changed

Lines changed: 9 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,11 @@ not need any of them.
168168
- Engine render markers implement backend-neutral `Render`. Do not
169169
add backend-specific render interfaces back into
170170
`engine/components`.
171-
- PDF rendering logic lives in
172-
`src/main/java/com/demcha/compose/engine/render/pdf/handlers/`.
171+
- PDF rendering logic for the legacy ECS renderer (deprecated; canonical PDF
172+
output goes through `com.demcha.compose.document.backend.fixed.pdf`) lives in
173+
`src/main/java/com/demcha/compose/engine/render/pdf/ecs/handlers/`.
173174
Backend-only helper objects live in
174-
`com.demcha.compose.engine.render.pdf.helpers`, not in
175+
`com.demcha.compose.engine.render.pdf.ecs.helpers`, not in
175176
`components/renderable`.
176177
- Builders and layout code get text width and line metrics from
177178
`TextMeasurementSystem`, not from
@@ -208,7 +209,7 @@ The rules above are enforced by tests:
208209
[EnginePdfBoundaryTest.java](./src/test/java/com/demcha/compose/engine/architecture/EnginePdfBoundaryTest.java),
209210
[CanonicalTemplateComposerPdfBoundaryTest.java](./src/test/java/com/demcha/compose/document/templates/architecture/CanonicalTemplateComposerPdfBoundaryTest.java),
210211
[PdfRenderInterfaceGuardTest.java](./src/test/java/com/demcha/compose/engine/render/pdf/PdfRenderInterfaceGuardTest.java),
211-
[PdfRenderingSystemECSDispatchTest.java](./src/test/java/com/demcha/compose/engine/render/pdf/PdfRenderingSystemECSDispatchTest.java)
212+
[PdfRenderingSystemECSDispatchTest.java](./src/test/java/com/demcha/compose/engine/render/pdf/ecs/PdfRenderingSystemECSDispatchTest.java)
212213

213214
## Adding a new feature
214215

@@ -325,7 +326,7 @@ Choose the smallest tests that match the change:
325326
- For low-level test harness changes:
326327
[ComponentBuilderTest.java](./src/test/java/com/demcha/compose/engine/components/ComponentBuilderTest.java)
327328
- For render-marker dispatch changes:
328-
[PdfRenderingSystemECSDispatchTest.java](./src/test/java/com/demcha/compose/engine/render/pdf/PdfRenderingSystemECSDispatchTest.java)
329+
[PdfRenderingSystemECSDispatchTest.java](./src/test/java/com/demcha/compose/engine/render/pdf/ecs/PdfRenderingSystemECSDispatchTest.java)
329330
- For layout/positioning behavior:
330331
[ComputedPositionTest.java](./src/test/java/com/demcha/compose/engine/components/layout/ComputedPositionTest.java)
331332
- For pagination and multi-page behavior:

docs/architecture/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,8 +231,8 @@ code should not need any of them.
231231
into the active renderer
232232
- render marker components identify *what* needs to be rendered;
233233
*how* it is drawn lives in renderer-owned handler packages such as
234-
`...render.pdf.handlers` (with helper objects under
235-
`...render.pdf.helpers`)
234+
`...render.pdf.ecs.handlers` (with helper objects under
235+
`...render.pdf.ecs.helpers`)
236236
- `RenderStream` acts as a session factory, not as a per-entity
237237
content-stream opener
238238
- `RenderPassSession` is the shared seam for page lifetime and

docs/contributing/implementation-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ Relevant files:
259259

260260
- [TableBuilder.java](./../src/test/java/com/demcha/compose/testsupport/engine/assembly/TableBuilder.java)
261261
- [TableRow.java](./../src/main/java/com/demcha/compose/engine/components/renderable/TableRow.java)
262-
- [TableCellBox.java](./../src/main/java/com/demcha/compose/engine/render/pdf/helpers/TableCellBox.java)
262+
- [TableCellBox.java](./../src/main/java/com/demcha/compose/engine/render/pdf/ecs/helpers/TableCellBox.java)
263263
- [TableResolvedCell.java](./../src/main/java/com/demcha/compose/engine/components/content/table/TableResolvedCell.java)
264264

265265
Rule of thumb:

0 commit comments

Comments
 (0)