Skip to content

docs: correct MIGRATION jsonSchema -> toCodecJson annotation name - #136

Open
detail-app[bot] wants to merge 1 commit into
mainfrom
detail/fix-docs/docs-correct-migration-jsonschema-tocodecjson-anno-2d0fcd
Open

detail-app[bot] wants to merge 1 commit into
mainfrom
detail/fix-docs/docs-correct-migration-jsonschema-tocodecjson-anno-2d0fcd

Conversation

@detail-app

@detail-app detail-app Bot commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Section 9 of MIGRATION.md said sentinel and Firestore type schemas carry jsonSchema annotations, but the underlying implementation was replaced with representation + toCodecJson links. The term jsonSchema no longer matches any option name in the code, so the migration guide contradicted the updated AGENTS.md JSON Schema section and would mislead anyone upgrading from v0.x into using a non-existent annotation.

Introduced by commit 2c6dc8a (@fwal, #134)


Doc Drift PRs can be configured here.

@detail-app
detail-app Bot requested a review from fwal as a code owner September 23, 2026 17:36
@github-actions github-actions Bot added 📖 docs Improvements or additions to documentation 🐛 fix Something is broken or doesn't work properly 📦 core labels Sep 23, 2026
@greptile-apps

greptile-apps Bot commented Sep 23, 2026

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

The PR appears safe to merge.

What we checked:

  • Migration guide names the right hook: Yes. The schemas use a toCodecJson hook, and the package guide uses the same name.
Summary

The migration guide now names the JSON codec hook as toCodecJson instead of the outdated jsonSchema option. This keeps the upgrade instructions aligned with the current Firestore schema code.

Diagram
sequenceDiagram
    participant D as Developer
    participant M as MIGRATION.md
    participant S as Firestore schema
    participant J as JSON codec
    D->>M: Read the v1 migration guide
    M-->>D: Name the `toCodecJson` annotation
    D->>S: "Use a model's `json*` variant"
    S->>J: Follow the `toCodecJson` link
    J-->>D: Produce JSON-safe data and schema
Loading

Reviews (1) · Last reviewed commit: "docs: correct MIGRATION jsonSchema -> to..."

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📦 core 📖 docs Improvements or additions to documentation 🐛 fix Something is broken or doesn't work properly

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant