Skip to content

karma/hyper 142 quickstart page#79

Merged
Kzoeps merged 3 commits into
mainfrom
karma/hyper-142-quickstart-page
Mar 5, 2026
Merged

karma/hyper 142 quickstart page#79
Kzoeps merged 3 commits into
mainfrom
karma/hyper-142-quickstart-page

Conversation

@Kzoeps
Copy link
Copy Markdown
Contributor

@Kzoeps Kzoeps commented Mar 5, 2026

  • feat: update quickstart
  • docs: update record creation and add hypercert addition through ui

Summary by CodeRabbit

  • Documentation
    • Updated quickstart to use a browser-friendly OAuth authorize/callback flow and revised example to show session-based repository access and hypercert creation.
    • Added "Create a hypercert without code" guide with step-by-step Scaffold app workflow: sign-in, basic info, attachments, location, measurements, and evaluations.

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Mar 5, 2026

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

Project Deployment Actions Updated (UTC)
hypercerts-atproto-documentation Ready Ready Preview, Comment Mar 5, 2026 10:36am
hypercerts-v0.2-documentation Ready Ready Preview, Comment Mar 5, 2026 10:36am

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 5, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4b42e4dd-b8d4-4193-bc89-7e4ae2e88913

📥 Commits

Reviewing files that changed from the base of the PR and between b4a0959 and 8a63a79.

📒 Files selected for processing (1)
  • pages/getting-started/quickstart.md

📝 Walkthrough

Walkthrough

Replaces AtpAgent-based server login with NodeOAuthClient authorize()/callback() browser OAuth flow, updates imports and session usage, and refactors the hypercert creation example to use an explicit workScope object with $type. Adds a "Create a hypercert without code" guide section.

Changes

Cohort / File(s) Summary
Documentation & Code Examples
pages/getting-started/quickstart.md
Replaced @atproto/api/AtpAgent usage with @atproto/oauth-client-node/NodeOAuthClient; changed auth flow from login() to authorize() + callback() with redirect/callback semantics; session references moved from agent.session.did to session.did; hypercert record payload now includes explicit $type and a workScope object with discriminator and scope; added "Create a hypercert without code" section and updated console logging to show full creation result.

Sequence Diagram(s)

sequenceDiagram
  participant Browser
  participant AppServer as NodeOAuthClient
  participant PDS
  participant Session as SessionObject
  participant Repo as ATProtoRepo

  Browser->>AppServer: GET /authorize (user clicks "Connect")
  AppServer->>PDS: authorize(...) -> returns authorization URL
  AppServer-->>Browser: 302 redirect to PDS auth URL
  Browser->>PDS: User authenticates & approves
  PDS-->>Browser: Redirect back with callback params
  Browser->>AppServer: GET /callback?code=...
  AppServer->>PDS: callback(params) -> exchange code for session
  PDS-->>AppServer: session (includes session.did and session.agent)
  AppServer->>Repo: session.agent.com.atproto.repo.createRecord(repo: session.did, record: {...workScope...})
  Repo-->>AppServer: creation result
  AppServer-->>Browser: Show result / console.log(result)
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • karma/hyper 142 quickstart page #79 — Mirrors the same quickstart changes: swapping AtpAgent for NodeOAuthClient (authorize/callback) and updating hypercert record payload/session usage.

Poem

🐰 I hopped to the PDS, tail all a-twitch,
Authorize first, then callback the switch,
Session in paw, I plant scope like a seed,
Hypercerts sprout where the workors lead,
A no-code carrot feast—oh what a stitch! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title 'karma/hyper 142 quickstart page' is a branch name reference rather than a descriptive summary of the changes made in the pull request. Replace with a clear, descriptive title that summarizes the main changes, such as 'Update quickstart guide with OAuth authentication flow and UI-based hypercert creation' or 'Migrate quickstart to NodeOAuthClient and add UI creation guide'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch karma/hyper-142-quickstart-page

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@pages/getting-started/quickstart.md`:
- Around line 164-169: Update the table entries to correct terminology and
capitalization: change "DIDS" to "DIDs" in the "Evaluators" row, and replace the
"Measurement" row's fragment "URI to the measurement that is tied to this
evaluation. Could be a normal url as well" with a full sentence such as "URI to
the measurement tied to this evaluation. It can also be a normal URL." Ensure
"URL" is capitalized.
- Line 43: Update the sentence in pages/getting-started/quickstart.md: replace
"checkout" with "check out" and "setup OAuth" with "set up OAuth" so the
sentence reads more cleanly (the sentence that starts "See the [AT Protocol
OAuth documentation]..."; also ensure link text like "[AT Protos node.js
implementation tutorial]" remains unchanged aside from the two wording fixes).
- Around line 20-22: The Markdoc callout uses an unsupported type value: change
the callout tag's type attribute from "note" to a supported value (for example
"info") in the callout surrounding the React app note (the {% callout
type="note" %} ... {% /callout %} block) so the page will render correctly;
update the type attribute and ensure the opening and closing {% callout %} tags
remain balanced.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 13940360-1940-4c74-9203-7702e226b5a8

📥 Commits

Reviewing files that changed from the base of the PR and between e9dbb52 and b4a0959.

📒 Files selected for processing (1)
  • pages/getting-started/quickstart.md

Comment thread pages/getting-started/quickstart.md Outdated
Comment thread pages/getting-started/quickstart.md Outdated
Comment thread pages/getting-started/quickstart.md Outdated
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