Repository navigation
docs: protocol 2.0 release notes and lexicon 2.0 usage - #179
Merged
Merged
Conversation
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars.
 |
Protocol 2.0 tracks @hypercerts-org/lexicon 2.0.0, which changes the TypeScript package but no lexicon. The introduction page's validation example moves to the new @atproto/lex schemas.
kristoferlund
force-pushed
the
docs/lexicon-2-0
branch
from
November 3, 2026 07:52
f364be7 to
9811f80
Compare
This branch was successfully deployed
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
Release notes and usage docs for
@hypercerts-org/lexicon2.0.0 (hypercerts-org/hypercerts-lexicon#270, released by hypercerts-org/hypercerts-lexicon#271). Protocol 2.0 tracks the Lexicon package's major version, as agreed: the package changed in a breaking way, but no lexicon changed and every existing record remains valid. The notes say so up front.lib/protocol-releases.json: a 2.0 entry: schemas and types for the modern@atproto/lexclient,$safeParserequiring$type, the 1.x API moving to/legacy, and what existing integrations need to change.pages/releases/protocol.md: one sentence noting that a major version can come from a breaking package change alone, as in 2.0, and that each release's notes say whether records are affected.pages/lexicons/introduction-to-lexicons.md: the "Validate records before writing" example usedACTIVITY_NSIDandOrgHypercertsClaimActivityfrom the package root, which move to/legacyin 2.0. It now installs@atproto/lex, writes withclient.create(…, { validateRequest: true }), checks other data with$safeParse, and points 1.x code to/legacyand the README's migration guide. The example typechecks against the 2.0 build, and its record validates.test/releases.test.js: updated for the 2.0 line, as for 1.6./reference/releasesneeds no change: it renders the Lexicon changelog, which gets its 2.0.0 entry when #271 is merged. Nothing else in the docs imports the package API; the schema tables and example tests read the lexicon JSON files, which did not change.Merge after the release
Merge this after
@hypercerts-org/lexicon@2.0.0is published. The notes link to thev2.0.0tag and README, and the date (2026-11-03) is the planned release day; adjust it if the release slips. Dependabot bumps the site's pinned package version afterwards, as usual.pnpm testpasses (81 tests).