Skip to content

Merge quickstart and create cert#81

Merged
Kzoeps merged 2 commits intomainfrom
karma/hyper-143-creating-your-first-hypercert-page
Mar 5, 2026
Merged

Merge quickstart and create cert#81
Kzoeps merged 2 commits intomainfrom
karma/hyper-143-creating-your-first-hypercert-page

Conversation

@Kzoeps
Copy link
Contributor

@Kzoeps Kzoeps commented Mar 5, 2026

  • add measuremetn, evaluation and contribution section properly.

Summary by CodeRabbit

  • New Features

    • Added comprehensive documentation on planned funding and tokenization concepts.
    • Introduced enhanced navigation with collapsible sections (Architecture, Tools, Tutorials, Reference).
    • Added draft page management system with dedicated drafts listing.
  • Documentation

    • Expanded Quickstart guide with detailed examples for building complete hypercerts.
    • Reorganized infrastructure documentation into focused sub-pages.
    • Updated internal documentation links to reflect reorganized content structure.
    • Refreshed landing page with new feature cards.
  • Style

    • Improved documentation site visual styling and responsive design.

@vercel
Copy link
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 11:21am
hypercerts-v0.2-documentation Ready Ready Preview, Comment Mar 5, 2026 11:21am

Request Review

@coderabbitai
Copy link

coderabbitai bot commented Mar 5, 2026

Warning

Rate limit exceeded

@Kzoeps has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 16 minutes and 24 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 06511d3d-2ec6-4f03-8396-b327f38aab72

📥 Commits

Reviewing files that changed from the base of the PR and between ea059a2 and 0314afd.

📒 Files selected for processing (2)
  • pages/getting-started/quickstart.md
  • pages/reference/faq.md
📝 Walkthrough

Walkthrough

This PR consolidates documentation by removing a redundant "Creating Your First Hypercert" page and merging its content into the Quickstart guide. Navigation entries and cross-references throughout the documentation are updated to point to the consolidated Quickstart instead.

Changes

Cohort / File(s) Summary
Page Consolidation
pages/getting-started/creating-your-first-hypercert.md, pages/getting-started/quickstart.md
Removed dedicated "Creating Your First Hypercert" page (174 lines); expanded Quickstart with activity-claim structure, contributions, attachments, measurements, and evaluations sections (+161 lines).
Navigation Update
lib/navigation.js
Removed navigation entry for "Creating Your First Hypercert" from Get Started → Quickstart section.
Cross-Reference Updates
pages/architecture/account-and-identity.md, pages/architecture/data-flow-and-lifecycle.md, pages/core-concepts/funding-and-value-flow.md, pages/core-concepts/hypercerts-core-data-model.md, pages/index.md, pages/tools/hyperboards.md
Updated links and card references from "Creating Your First Hypercert" to "Quickstart" across multiple documentation pages.
Planning & Infrastructure
.beads/issues.jsonl
Updated project tracking to reflect planned on-chain funding, tokenization infrastructure, new UI components (DotPattern, HeroBanner, CardGrid, etc.), draft management, and navigation restructuring.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • s-adamantine

Poem

🐰 One page was split, now consolidated bright,
The Quickstart absorbs what once took flight,
Links point true where paths now blend,
No more redirects, just a cleaner end,
Docs now flow from start to end! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: merging the 'Creating Your First Hypercert' page into the Quickstart guide, consolidating the two documents into one comprehensive resource.
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-143-creating-your-first-hypercert-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

@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: 2

🧹 Nitpick comments (1)
pages/core-concepts/hypercerts-core-data-model.md (1)

98-98: Remove duplicate Quickstart bullet in “What happens next.”

Line 98 duplicates the same destination already listed on Line 97. Keep one Quickstart item and merge the wording to avoid redundant navigation.

Proposed cleanup
-- **[Quickstart](/getting-started/quickstart)** — create your first activity claim
- - **[Quickstart](/getting-started/quickstart)** — build a complete hypercert with all record types
+- **[Quickstart](/getting-started/quickstart)** — create your first activity claim and expand it with related record types
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pages/core-concepts/hypercerts-core-data-model.md` at line 98, In the "What
happens next." section remove the duplicate bullet that repeats
"**[Quickstart](/getting-started/quickstart)** — build a complete hypercert with
all record types" so only one Quickstart entry remains; merge or reconcile
wording between the two occurrences into that single bullet to preserve any
unique phrasing, ensuring the final item reads clearly and avoids redundancy.
🤖 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`:
- Line 52: Update the Markdown so the "app.certified.location" reference links
to the Location lexicon page rather than the activity-claim page: locate the
line containing **Locations** and the anchor text `app.certified.location`, and
change the URL from the activity-claim lexicon to the correct location lexicon
page (the location lexicon entry) so clicks navigate to the Location schema
documentation.
- Line 49: The doc currently references the wrong record name: replace
references to org.hypercerts.claim.contribution (and the link
/lexicons/hypercerts-lexicons/contribution) with the correct
org.hypercerts.claim.contributionDetails (and its matching lexicon link) so
contributorDetails points to the right schema; update the sentence describing
contributors (the `contributors` array, `contributorIdentity`,
`contributionWeight`, and `contributionDetails`) to link `contributionDetails`
to org.hypercerts.claim.contributionDetails and ensure the inline mention
`contributionDetails` matches that symbol throughout the quickstart content
(including the other occurrence around lines ~130–133).

---

Nitpick comments:
In `@pages/core-concepts/hypercerts-core-data-model.md`:
- Line 98: In the "What happens next." section remove the duplicate bullet that
repeats "**[Quickstart](/getting-started/quickstart)** — build a complete
hypercert with all record types" so only one Quickstart entry remains; merge or
reconcile wording between the two occurrences into that single bullet to
preserve any unique phrasing, ensuring the final item reads clearly and avoids
redundancy.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 14943619-066a-4821-972f-ba80dc31cb98

📥 Commits

Reviewing files that changed from the base of the PR and between ade3db3 and ea059a2.

📒 Files selected for processing (10)
  • .beads/issues.jsonl
  • lib/navigation.js
  • pages/architecture/account-and-identity.md
  • pages/architecture/data-flow-and-lifecycle.md
  • pages/core-concepts/funding-and-value-flow.md
  • pages/core-concepts/hypercerts-core-data-model.md
  • pages/getting-started/creating-your-first-hypercert.md
  • pages/getting-started/quickstart.md
  • pages/index.md
  • pages/tools/hyperboards.md
💤 Files with no reviewable changes (2)
  • lib/navigation.js
  • pages/getting-started/creating-your-first-hypercert.md


The activity claim is the core record — it describes what work was done, when, and in what scope. Here's how each field maps to the [activity lexicon](/lexicons/hypercerts-lexicons/activity-claim):

- **Contributors** are embedded directly in the activity claim as a `contributors` array. Each entry has a `contributorIdentity` (inline DID string, or a strong reference to a [`contributorInformation`](/lexicons/hypercerts-lexicons/contributor-information) record), an optional `contributionWeight`, and an optional `contributionDetails` (inline role string, or a strong reference to an [`org.hypercerts.claim.contribution`](/lexicons/hypercerts-lexicons/contribution) record for richer detail).
Copy link

@coderabbitai coderabbitai bot Mar 5, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix contributor-details record naming/link for consistency.

Line 49 and Line 132 reference org.hypercerts.claim.contribution (/lexicons/hypercerts-lexicons/contribution), while related docs use org.hypercerts.claim.contributionDetails. This can mislead implementers to the wrong schema/type.

Proposed wording fix
-- ... strong reference to an [`org.hypercerts.claim.contribution`](/lexicons/hypercerts-lexicons/contribution) record for richer detail).
+- ... strong reference to an [`org.hypercerts.claim.contributionDetails`](/lexicons/hypercerts-lexicons/contribution-details) record for richer detail).

Also applies to: 130-133

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pages/getting-started/quickstart.md` at line 49, The doc currently references
the wrong record name: replace references to org.hypercerts.claim.contribution
(and the link /lexicons/hypercerts-lexicons/contribution) with the correct
org.hypercerts.claim.contributionDetails (and its matching lexicon link) so
contributorDetails points to the right schema; update the sentence describing
contributors (the `contributors` array, `contributorIdentity`,
`contributionWeight`, and `contributionDetails`) to link `contributionDetails`
to org.hypercerts.claim.contributionDetails and ensure the inline mention
`contributionDetails` matches that symbol throughout the quickstart content
(including the other occurrence around lines ~130–133).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

these should be chagned in respective files. especially since lexicons is outdated right now

Copy link

Choose a reason for hiding this comment

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

@Kzoeps, understood — the lexicon references in the quickstart should stay in sync with whatever the lexicon files settle on once they're updated. I'll note that the lexicons are currently outdated so future reviews don't flag mismatches as issues in the quickstart.


✏️ Learnings added
Learnt from: Kzoeps
Repo: hypercerts-org/documentation PR: 81
File: pages/getting-started/quickstart.md:49-49
Timestamp: 2026-03-05T11:22:03.959Z
Learning: In the hypercerts-org/documentation repository, the `/lexicons/` section is currently outdated. References to lexicon types (e.g., `org.hypercerts.claim.contribution`, `org.hypercerts.claim.contributionDetails`) in the quickstart and other pages should be updated together with the respective lexicon files once they are refreshed, not independently.

Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.

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