hypercerts-org / hypercerts-org/documentation
Use the canonical evaluation lexicon in the example.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 3
- Avg merge
- 9h 48m
- Merged PRs (30d)
- 5
Description
⚠️ 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 https://github.com/hypercerts-org/documentation/pull/110#discussion_r3021210219
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in public/raw/getting-started/building-on-hypercerts.md around lines 44–50 and compare the evaluation identifiers with public/raw/roadmap.md at lines 67 and 133. Resolve the conflicting canonical-name statements in the issue, then update the example and any matching occurrences consistently; verify the related /lexicons/ references and lexicon refresh before considering it done.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 48/100