Skip to content

docs: add Hyperscan documentation#134

Merged
Kzoeps merged 1 commit into
mainfrom
hyperscan-docs
May 13, 2026
Merged

docs: add Hyperscan documentation#134
Kzoeps merged 1 commit into
mainfrom
hyperscan-docs

Conversation

@Kzoeps

@Kzoeps Kzoeps commented May 13, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add a new Hyperscan tools documentation page focused on Feed, Data Explorer, infrastructure views, and Agent API endpoints.
  • Add Hyperscan to the Tools navigation.
  • Link existing Hyperindex and Certified Services references to the new docs page.

Verification

  • npm run build

Summary by CodeRabbit

  • New Features

    • Added comprehensive Hyperscan documentation page featuring public explorer overview, data explorer details, infrastructure views including stats and indexer data, Agent API endpoints with usage examples, and references to related ecosystem tools.
  • Documentation

    • Updated site navigation and internal documentation links to include new Hyperscan reference material.

Review Change Stack

@vercel

vercel Bot commented May 13, 2026

Copy link
Copy Markdown
Contributor

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

Project Deployment Actions Updated (UTC)
hypercerts-v0.2-documentation Ready Ready Preview, Comment May 13, 2026 6:35am

Request Review

@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Adds a new Hyperscan tool documentation page covering features and API endpoints, registers it in site navigation, and updates existing references to link internally instead of to an external URL.

Changes

Hyperscan Documentation Integration

Layer / File(s) Summary
Hyperscan documentation page
pages/tools/hyperscan.md
New documentation describing Hyperscan as a public explorer for Hypercerts and ATProto data, with sections for Feed, Data Explorer, Infrastructure Views, Agent API endpoints, and cross-references.
Navigation and internal link updates
lib/navigation.js, pages/reference/certified-services.md, pages/tools/hyperindex.md
Navigation entry registered for Hyperscan under Tools; certified-services table entry updated to link internally to /tools/hyperscan; hyperindex documentation changed to reference internal path instead of external URL.

Possibly related PRs

  • hypercerts-org/documentation#131: Both PRs update lib/navigation.js to add a new entry under the Tools section and modify pages/reference/certified-services.md to link newly documented services.
  • hypercerts-org/documentation#98: Both PRs extend lib/navigation.js's Tools section by adding new documentation entries, modifying the same navigation data structure.
  • hypercerts-org/documentation#122: Both PRs modify lib/navigation.js to add new documentation entries and update pages/tools/hyperindex.md to link to newly documented endpoints.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A tool for scanning Hypercerts so bright,
Now documented and wired just right,
Links internal and clean,
The best seen between,
Navigation shines with new light!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title 'docs: add Hyperscan documentation' directly and accurately summarizes the main change: adding new Hyperscan documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch hyperscan-docs

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pages/tools/hyperscan.md`:
- Around line 114-116: Update the example curl endpoint to use the canonical
lexicon namespace: replace the stale `org.hypercerts.claim.activity` reference
in the curl command on the line reading "curl
https://www.hyperscan.dev/agents/lexicon/org.hypercerts.claim.activity" with the
canonical `org.hypercerts.context.activity` (i.e., use
`org.hypercerts.context.*` instead of `org.hypercerts.claim.*`) so the docs
point to the correct lexicon.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0dd87d60-9cb8-49e0-b9e2-659ac35c2c0f

📥 Commits

Reviewing files that changed from the base of the PR and between 8deed4e and dff1453.

📒 Files selected for processing (4)
  • lib/navigation.js
  • pages/reference/certified-services.md
  • pages/tools/hyperindex.md
  • pages/tools/hyperscan.md

Comment thread pages/tools/hyperscan.md
@Kzoeps Kzoeps merged commit 20b2648 into main May 13, 2026
3 checks passed
@Kzoeps Kzoeps deleted the hyperscan-docs branch May 13, 2026 06:50
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