Skip to content

docs: add the @hypercerts-org/api package (Hypercerts API types) - #182

Merged
kristoferlund merged 1 commit into
mainfrom
docs/api-types-package
Nov 3, 2026
Merged

kristoferlund merged 1 commit into
mainfrom
docs/api-types-package

Conversation

@kristoferlund

Copy link
Copy Markdown
Contributor

Summary

@hypercerts-org/api 0.1.0 was published to npm on 2026-11-03 (hypercerts-org/api#48, TECH-829): typed query definitions for calling the Hypercerts API with @atproto/lex. The docs did not mention it; the API reference page still said to "use the SDK when available". The service's own release notes stay where they are.

  • Release component "Hypercerts API types" (lib/release-components.json, docs-sources.yml, pages/releases/api-types.md): the package's changelog (packages/api/CHANGELOG.md), tracked by its @hypercerts-org/api@ tags, with its own sidebar badge and release card. The existing "Hypercerts API" page keeps tracking the service (@hypercerts-org/happyview-modules, v0.3.0); the two are released independently from the same repository, which fix: track the API release by its tag prefix, not the repository's latest #181 made possible.
  • API reference page (pages/reference/services/hypercerts-api.md): a "From TypeScript" section with install and a getActivity example, the response-validation caveat from the package README (TECH-791), and links to both release pages.
  • SDK page: points to the package and that section.
  • docs/remote-markdown.md: eight components, not seven.

The example typechecks against the published @hypercerts-org/api 0.1.0, @hypercerts-org/lexicon 2.0.0 and @atproto/lex 0.4.2, and returned a live activity from api.hypercerts.dev. Generating against GitHub shows API v0.3.0 and API types v0.1.0.

The "Hypercerts API" page's heading still reads @hypercerts-org/hypercerts-api, the package's old name: it is the first line of the changelog in the API repository, fixed there separately.

pnpm test passes (82 tests).

A release page and component for the npm package, tracked by its
@hypercerts-org/api@ tags, next to the service's release notes; a
TypeScript example on the API reference page; and a pointer from the SDK
page.
@vercel

vercel Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
hypercerts-v0.2-documentation Ready Ready Preview Nov 3, 2026 10:05am UTC

Request Review

@coderabbitai

coderabbitai Bot commented Nov 3, 2026

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: a47a623d-b24c-455f-967f-b7db0ef5398b
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

CodeRabbit Verify

  • Run CodeRabbit Verify to test the changes in this pull request.

@kristoferlund
kristoferlund merged commit fbc6090 into main Nov 3, 2026
6 checks passed

This branch was successfully deployed

1 active deployment
Preview — 1f516b65 Deployed Nov 3, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant