Skip to content

Use the canonical evaluation lexicon in the example. #114

@Kzoeps

Description

@Kzoeps

⚠️ Potential issue | 🟠 Major

Use the canonical evaluation lexicon in the example.

The sample uses org.hypercerts.context.evaluation, but the rest of this PR documents evaluations as org.hypercerts.claim.evaluation (see public/raw/roadmap.md, Line 67 and Line 133). This inconsistency can lead builders to write records to the wrong collection/type.

The right/canonical NSID is org.hypercerts.context.evaluation

Suggested fix
-  collection: "org.hypercerts.context.evaluation",
+  collection: "org.hypercerts.claim.evaluation",
   record: {
     subject: { uri: claimUri, cid: claimCid },
     evaluators: [{ did: "did:plc:ragtjsm2j2vknwkz3zp4oxrd" }],
     summary: "Scientific rigor and reproducibility assessment",
-    $type: "org.hypercerts.context.evaluation",
+    $type: "org.hypercerts.claim.evaluation",
     createdAt: new Date().toISOString(),
   },

Based on learnings: In this repository, /lexicons/ references should be updated together with the corresponding lexicon refresh, not independently.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

  collection: "org.hypercerts.claim.evaluation",
  record: {
    subject: { uri: claimUri, cid: claimCid },
    evaluators: [{ did: "did:plc:ragtjsm2j2vknwkz3zp4oxrd" }],
    summary: "Scientific rigor and reproducibility assessment",
    $type: "org.hypercerts.claim.evaluation",
    createdAt: new Date().toISOString(),
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@public/raw/getting-started/building-on-hypercerts.md` around lines 44 - 50,
The example uses the wrong evaluation lexicon: update the collection and $type
in the record from "org.hypercerts.context.evaluation" to the canonical
"org.hypercerts.claim.evaluation" so the sample writes to the same lexicon used
elsewhere; specifically change the collection value and the record.$type (and
any other occurrences of "org.hypercerts.context.evaluation" in this file) to
"org.hypercerts.claim.evaluation" to ensure consistency with the repository's
lexicon references.

Originally posted by @coderabbitai[bot] in #110 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions