Skip to content

Commit d80fc7e

Browse files
committed
Move v5.4.0 README notes
1 parent 44fb4d0 commit d80fc7e

1 file changed

Lines changed: 17 additions & 16 deletions

File tree

README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,6 @@ Kirby 5 is the active schema target. New docs-parity fixes, fixture updates and
1616

1717
The Kirby 3 and Kirby 4 schemas remain downloadable as frozen legacy artifacts, but they do not receive new docs-parity fixes or refactor work.
1818

19-
## What v5.4.0 Is About
20-
21-
v5.4.0 is not just a version bump. It is a Kirby 5 schema parity release.
22-
23-
The schema was audited against Kirby 5's upstream blueprint, field, section and Panel code. The main goal was to reduce false errors in IDEs for blueprint shapes that Kirby 5 really accepts, while also rejecting shapes that were only accepted by this schema by accident.
24-
25-
Highlights:
26-
27-
- `kirby5-blueprints.schema.json` is now generated from smaller source files in `schema/kirby5/**`.
28-
- The test suite now validates canonical fixtures, official docs examples, Starterkit blueprints, reusable shape variants and pinned property manifests.
29-
- Kirby 5-only support was expanded for translated labels/text, richer `options` forms, query/API option providers, fieldset shorthands, optional column widths, blueprint buttons, page preset inputs, boolean blueprint `options`/`permissions`, file `accept: true` and additional field properties.
30-
- Over-accepted shapes were tightened for picker and section `query`/`search`, files/pages sections, `link.options`, `headline.numbered`, stats sizes and numeric `step` values.
31-
- Known defaults were corrected for `date.calendar`, `textarea.spellcheck`, `files.multiple` and `structure.prepend`.
32-
33-
In short: v5.4.0 makes the Kirby 5 schema more faithful to Kirby itself. It does not try to model dynamic behavior such as `extends` resolution, plugin-defined fields/sections or runtime blueprint mutations.
34-
3519
## Install
3620

3721
### Schemastore (not yet)
@@ -112,6 +96,23 @@ fields:
11296

11397
The `extends` property on blueprint definitions is an edge case for the schema. The schema is a pattern matcher at heart, and it cannot validate what you are extending from in inspecting referenced files. There is no way that I am aware of to make `extends` play nice. For that reason I decided to have the schema surface an error instead of muting/hiding the inability to validate that part of the blueprint.
11498

99+
## What v5.4.0 Is About
100+
101+
v5.4.0 is not just a version bump. It is a Kirby 5 schema parity release.
102+
103+
The schema was audited against Kirby 5's upstream blueprint, field, section and Panel code. The main goal was to reduce false errors in IDEs for blueprint shapes that Kirby 5 really accepts, while also rejecting shapes that were only accepted by this schema by accident.
104+
105+
Highlights:
106+
107+
- `kirby5-blueprints.schema.json` is now generated from smaller source files in `schema/kirby5/**`.
108+
- The test suite now validates canonical fixtures, official docs examples, Starterkit blueprints, reusable shape variants and pinned property manifests.
109+
- The current test suite covers 1742 tests.
110+
- Kirby 5-only support was expanded for translated labels/text, richer `options` forms, query/API option providers, fieldset shorthands, optional column widths, blueprint buttons, page preset inputs, boolean blueprint `options`/`permissions`, file `accept: true` and additional field properties.
111+
- Over-accepted shapes were tightened for picker and section `query`/`search`, files/pages sections, `link.options`, `headline.numbered`, stats sizes and numeric `step` values.
112+
- Known defaults were corrected for `date.calendar`, `textarea.spellcheck`, `files.multiple` and `structure.prepend`.
113+
114+
In short: v5.4.0 makes the Kirby 5 schema more faithful to Kirby itself. It does not try to model dynamic behavior such as `extends` resolution, plugin-defined fields/sections or runtime blueprint mutations.
115+
115116
## Validate
116117

117118
Check out the test files in the `tests` folder on how to programmatically validate your blueprints with the schema. You can use a similar setup in your CI pipeline.

0 commit comments

Comments
 (0)