Repository navigation
Fix docs examples that don't compile or mislead - #69
Merged
Merged
Conversation
DawidRobertNowak
force-pushed
the
docs/rotate-layout-method-names
branch
from
October 20, 2026 13:32
1b751b0 to
10083f1
Compare
- Rotate: RotateLayoutClockwise / RotateLayoutCounterclockwise; table basics: obsolete RotateLeft replaced. - SVG: describe the real scaling options (SVG keeps its aspect ratio); add a section on transparent colors (QuestPDF writes #AARRGGBB, the SVG renderer reads #RRGGBBAA); colors page points to it. - Barcodes: the QR example uses BarcodeFormat.QR_CODE. - Document operations: nested DocumentOperation types are qualified; document operations and ZUGFeRD use PDFA_Conformance instead of obsolete PdfA. - Units: Unit.Point, Unit.Centimetre, Unit.Millimetre, Unit.Mil (border, column, row, page settings, length units table, which also lists every unit once). - Generating output: GenerateSvg instead of GenerateSvgFiles. - Debug area: DebugArea instead of Debug. - Components: EmptyContainer.Create() instead of IContainer.Empty, and the missing parenthesis before GeneratePdf. - Dynamic components: usings for QuestPDF.Elements and System.Globalization. - Layers: additional layers continue across pages but are not repeated; point to the page Background / Foreground slots. - Text style: say what BreakAnywhere changes; long words already wrap. - Obsolete Grid, MinimalBox and Text(object) replaced with Column/Row, Shrink and string text; the rendered output is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
DawidRobertNowak
force-pushed
the
docs/rotate-layout-method-names
branch
from
October 20, 2026 13:47
10083f1 to
8465e1d
Compare
Verified by rendering: OffsetX = 50 moves the shadow by 100 px at 144 DPI. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The fallback link of the embedded text-hyperlink.pdf pointed to document-merge-continuous.pdf. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Times New Roman and Courier New are system fonts, which QuestPDF 2026.9 no longer loads by default, so the example threw. The tests switched to Noto Serif and JetBrains Mono; the page, its image and the intro sentence now match and point to font management. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…t, refine SVG color handling, and clean up dynamic components example.
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.
Summary
Docs examples that don't compile on the current QuestPDF, use obsolete APIs, or describe behaviour incorrectly. Every change verified on QuestPDF 2026.9.1.
Wrong or missing names (compile errors)
Rotate:
RotateCounterclockwise/RotateClockwise→RotateLayoutCounterclockwise/RotateLayoutClockwise; table basics: obsoleteRotateLeft()replaced.Document operations:
LayerConfiguration,DocumentAttachment,DocumentAttachmentRelationship,Encryption40Bit/128Bit/256Bit→DocumentOperation.…(nested types, 12 places).Units:
Unit.Points→Unit.Point;Unit.Millimeters,Unit.Millimeter→Unit.Millimetre;Unit.Centimeter→Unit.Centimetre;Unit.Mill→Unit.Mil(border, column, row, page settings, length units). The units table now lists every unit once and notes the British spelling.Generating output:
GenerateSvgFiles()→GenerateSvg().Debug area:
.Debug(...)→.DebugArea(...).Components:
IContainer.Empty→EmptyContainer.Create(), plus the missing)before.GeneratePdf(...).Style inheritance:
container.container.Padding(5)→container.Padding(5).Dynamic components:
using QuestPDF.Elements;(forDynamicContext) andusing System.Globalization;(forCultureInfo).Barcodes: the QR example used
BarcodeFormat.EAN_13→BarcodeFormat.QR_CODE.Text style, font family:
Times New Roman/Courier Neware system fonts, not loaded by default since 2026.9, so the example threw → the bundledNoto Serif/JetBrains Monothe tests already use; image regenerated, intro points to font management.Obsolete APIs
PdfA = true→PDFA_Conformance = PDFA_Conformance.PDFA_3B(document operations, ZUGFeRD).Grid→Column+Row(debug area, image basics, prototyping, document structure ×3), the replacement the obsolete message suggests.MinimalBox()→Shrink();Text(double)→Text($"{…}")(table header and footer).Misleading text
#AARRGGBB, the SVG renderer reads#RRGGBBAA, so usefill-opacityin SVG markup; the colors page links to it.OffsetX = 50moves the shadow by 100 px at 144 DPI).document-merge-continuous.pdf)./or-).Check
Grid,MinimalBoxandText(double)replacements render identically to the old code (positions of every rectangle, word and image compared), so the existing example images stay valid.npm run docs:buildpasses; merges cleanly withmainand with Make llms.txt a useful entry point for AI assistants #70.Why
Found by an AI documentation test: real developer questions answered by AI agents from the docs, every answer compiled. Most failures came from docs snippets like these, and tools that index the docs (e.g. Context7) copy them as they are.
🤖 Generated with Claude Code