You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Publishes canonical treedocs.yaml schema 0.2.0 at https://dandylyons.github.io/treedocs/schemas/0.2.0/treedocs.schema.json.
Moves the public latest schema endpoint to schema 0.2.0.
Keeps distribution source-only through SwiftPM-backed tooling. No prebuilt artifacts are included in this release.
Schema 0.2.0
Improve Intellisense hints on treedocs.schema.json. Now when you edit your treedocs.yaml in editors like VS Code, you should have more helpful docs and code completion.
We now consistently use _ prepended strings for our reserved keys. This should make it easier to avoid accidental name collisions with reserved keys for treedocs. Simply avoid naming files or folders with _ at the beginning. (Not a perfect solution. Hopefully we'll add something better in the future.)
Renames tree-entry object metadata keys from description / references to _description / _references.
Keeps compact string descriptions unchanged.
Keeps _doc and _link reserved metadata keys unchanged.
Reserves underscore-prefixed keys inside tree for treedocs metadata, allowing real filesystem entries named description/ and references/.
Compatibility
The 0.2.0 CLI can still read, validate, sync, and update schema_version: "0.1.0" files using the 0.1.0 metadata keys.
0.1.0 files are deprecated and commands warn with a pointer to DOCS/Migrating treedocs.yaml 0.1.0 to 0.2.0.md.
The 0.1.0 schema remains bundled for compatibility.
Verification
swift build passed.
swift test passed with 111 tests.
treedocs check passed.
A fresh treedocs init --non-interactive writes schema_version: 0.2.0.