Skip to content

Commit 94f42b7

Browse files
committed
update docs for lexicon usage (coderabbit comment)
1 parent 5322b5c commit 94f42b7

8 files changed

Lines changed: 28 additions & 28 deletions

File tree

pages/architecture/data-flow-and-lifecycle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ Contributors are embedded in the activity claim's `contributors` array. For rich
6060

6161
#### Attachment Records
6262

63-
`org.hypercerts.claim.attachment` records attach supporting documentation. Attachments can be URLs, file uploads, or structured data. Each attachment record includes a strong reference to the claim it supports.
63+
`org.hypercerts.context.attachment` records attach supporting documentation. Attachments can be URLs, file uploads, or structured data. Each attachment record includes a strong reference to the claim it supports.
6464

6565
#### Measurement Records
6666

67-
`org.hypercerts.claim.measurement` records provide quantitative data. A measurement specifies what was measured, the value, the unit, and the methodology. Multiple measurements can track different metrics.
67+
`org.hypercerts.context.measurement` records provide quantitative data. A measurement specifies what was measured, the value, the unit, and the methodology. Multiple measurements can track different metrics.
6868

6969
#### Rights Records
7070

@@ -98,7 +98,7 @@ at://did:alice/... at://did:bob/... at://did:carol/
9898

9999
Third parties assess the work by creating evaluation records on their own servers.
100100

101-
An evaluator creates an `org.hypercerts.claim.evaluation` record on their PDS. The evaluation includes a `subject` field with a strong reference to the activity claim. Strong references include both the AT-URI and the CID (content hash), ensuring the evaluation references a specific version of the claim.
101+
An evaluator creates an `org.hypercerts.context.evaluation` record on their PDS. The evaluation includes a `subject` field with a strong reference to the activity claim. Strong references include both the AT-URI and the CID (content hash), ensuring the evaluation references a specific version of the claim.
102102

103103
The evaluation record includes the evaluator's assessment. This can be a score, a category, structured feedback, or a link to a detailed report. The lexicon allows flexible evaluation formats.
104104

pages/core-concepts/hypercerts-core-data-model.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ The diagram includes a **token** entity — tokenization (anchoring a hypercert
4949

5050
| Record type | What it adds | Who creates it | Lexicon |
5151
|-------------|-------------|----------------|---------|
52-
| **Attachment** | Supporting documentation — URLs, uploaded files, IPFS links. Can link to any record type, not only activity claims. | Anyone with additional data | `org.hypercerts.claim.attachment` |
53-
| **Measurement** | Quantitative data — "12 pages written", "50 tons CO₂ reduced" | E.g. a third-party measurer or the project (self-reported) | `org.hypercerts.claim.measurement` |
54-
| **Evaluation** | An (independent) assessment of the work | E.g. a third-party evaluator, community members, beneficiaries | `org.hypercerts.claim.evaluation` |
52+
| **Attachment** | Supporting documentation — URLs, uploaded files, IPFS links. Can link to any record type, not only activity claims. | Anyone with additional data | `org.hypercerts.context.attachment` |
53+
| **Measurement** | Quantitative data — "12 pages written", "50 tons CO₂ reduced" | E.g. a third-party measurer or the project (self-reported) | `org.hypercerts.context.measurement` |
54+
| **Evaluation** | An (independent) assessment of the work | E.g. a third-party evaluator, community members, beneficiaries | `org.hypercerts.context.evaluation` |
5555

5656
### Additional notes
5757

pages/getting-started/working-with-evaluations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ await agent.login({
2121
// Create an evaluation of an activity claim
2222
const evaluation = await agent.com.atproto.repo.createRecord({
2323
repo: agent.session.did,
24-
collection: "org.hypercerts.claim.evaluation",
24+
collection: "org.hypercerts.context.evaluation",
2525
record: {
2626
subject: {
2727
uri: "at://did:plc:xyz789/org.hypercerts.claim.activity/3k2j4h5g6f7d8s9a",
2828
cid: "bafyreiabc123...",
2929
},
3030
evaluators: ["did:plc:evaluator123"],
3131
summary: "Verified documentation updates. All 15 examples tested and working. High quality contribution with clear impact on developer experience.",
32-
$type: "org.hypercerts.claim.evaluation",
32+
$type: "org.hypercerts.context.evaluation",
3333
createdAt: new Date().toISOString(),
3434
},
3535
});
@@ -46,7 +46,7 @@ Measurements provide quantitative data that supports your evaluation:
4646
```typescript
4747
const measurement = await agent.com.atproto.repo.createRecord({
4848
repo: agent.session.did,
49-
collection: "org.hypercerts.claim.measurement",
49+
collection: "org.hypercerts.context.measurement",
5050
record: {
5151
subject: {
5252
uri: "at://did:plc:xyz789/org.hypercerts.claim.activity/3k2j4h5g6f7d8s9a",
@@ -60,7 +60,7 @@ const measurement = await agent.com.atproto.repo.createRecord({
6060
methodURI: "https://example.com/analytics-methodology",
6161
evidenceURI: ["https://example.com/analytics-report.pdf"],
6262
comment: "Page view data collected over the first 30 days after publication.",
63-
$type: "org.hypercerts.claim.measurement",
63+
$type: "org.hypercerts.context.measurement",
6464
createdAt: new Date().toISOString(),
6565
},
6666
});

pages/tools/scaffold.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,9 +180,9 @@ ATProto has no built-in reverse lookup — given a hypercert URI, there is no na
180180

181181
Constellation indexes ATProto records and returns all records that reference a given subject URI. The scaffold queries three source paths:
182182

183-
- Attachments: `org.hypercerts.claim.attachment:subjects[com.atproto.repo.strongRef].uri`
184-
- Evaluations: `org.hypercerts.claim.evaluation:subject.uri`
185-
- Measurements: `org.hypercerts.claim.measurement:subject.uri`
183+
- Attachments: `org.hypercerts.context.attachment:subjects[com.atproto.repo.strongRef].uri`
184+
- Evaluations: `org.hypercerts.context.evaluation:subject.uri`
185+
- Measurements: `org.hypercerts.context.measurement:subject.uri`
186186

187187
The query hooks follow a two-step pattern: fetch backlink URIs from Constellation, then fetch each record's full data via Server Actions. This split is necessary because Constellation returns record identifiers, not record contents.
188188

@@ -294,4 +294,4 @@ hypercerts-scaffold/
294294
└── vendor/ # Packed dependency tarballs (pre-release)
295295
```
296296

297-
`app/` contains pages (server components by default) and API routes. `lib/` is split: top-level files are server-only, while `lib/api/` is the client-side fetch layer that browser code calls. `providers/` has one server component (`SignedInProvider`, which handles the auth gate and renders the Navbar) and one client component (`AllProviders`, which sets up the TanStack Query client). `queries/` is entirely client-side TanStack Query hooks. `components/` is entirely client-side React components.
297+
`app/` contains pages (server components by default) and API routes. `lib/` is split: top-level files are server-only, while `lib/api/` is the client-side fetch layer that browser code calls. `providers/` has one server component (`SignedInProvider`, which handles the auth gate and renders the Navbar) and one client component (`AllProviders`, which sets up the TanStack Query client). `queries/` is entirely client-side TanStack Query hooks. `components/` is entirely client-side React components.

public/raw/architecture/data-flow-and-lifecycle.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ Contributors are embedded in the activity claim's `contributors` array. For rich
6060

6161
#### Attachment Records
6262

63-
`org.hypercerts.claim.attachment` records attach supporting documentation. Attachments can be URLs, file uploads, or structured data. Each attachment record includes a strong reference to the claim it supports.
63+
`org.hypercerts.context.attachment` records attach supporting documentation. Attachments can be URLs, file uploads, or structured data. Each attachment record includes a strong reference to the claim it supports.
6464

6565
#### Measurement Records
6666

67-
`org.hypercerts.claim.measurement` records provide quantitative data. A measurement specifies what was measured, the value, the unit, and the methodology. Multiple measurements can track different metrics.
67+
`org.hypercerts.context.measurement` records provide quantitative data. A measurement specifies what was measured, the value, the unit, and the methodology. Multiple measurements can track different metrics.
6868

6969
#### Rights Records
7070

@@ -98,7 +98,7 @@ at://did:alice/... at://did:bob/... at://did:carol/
9898

9999
Third parties assess the work by creating evaluation records on their own servers.
100100

101-
An evaluator creates an `org.hypercerts.claim.evaluation` record on their PDS. The evaluation includes a `subject` field with a strong reference to the activity claim. Strong references include both the AT-URI and the CID (content hash), ensuring the evaluation references a specific version of the claim.
101+
An evaluator creates an `org.hypercerts.context.evaluation` record on their PDS. The evaluation includes a `subject` field with a strong reference to the activity claim. Strong references include both the AT-URI and the CID (content hash), ensuring the evaluation references a specific version of the claim.
102102

103103
The evaluation record includes the evaluator's assessment. This can be a score, a category, structured feedback, or a link to a detailed report. The lexicon allows flexible evaluation formats.
104104

public/raw/core-concepts/hypercerts-core-data-model.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ The diagram includes a **token** entity — tokenization (anchoring a hypercert
4949

5050
| Record type | What it adds | Who creates it | Lexicon |
5151
|-------------|-------------|----------------|---------|
52-
| **Attachment** | Supporting documentation — URLs, uploaded files, IPFS links. Can link to any record type, not only activity claims. | Anyone with additional data | `org.hypercerts.claim.attachment` |
53-
| **Measurement** | Quantitative data — "12 pages written", "50 tons CO₂ reduced" | E.g. a third-party measurer or the project (self-reported) | `org.hypercerts.claim.measurement` |
54-
| **Evaluation** | An (independent) assessment of the work | E.g. a third-party evaluator, community members, beneficiaries | `org.hypercerts.claim.evaluation` |
52+
| **Attachment** | Supporting documentation — URLs, uploaded files, IPFS links. Can link to any record type, not only activity claims. | Anyone with additional data | `org.hypercerts.context.attachment` |
53+
| **Measurement** | Quantitative data — "12 pages written", "50 tons CO₂ reduced" | E.g. a third-party measurer or the project (self-reported) | `org.hypercerts.context.measurement` |
54+
| **Evaluation** | An (independent) assessment of the work | E.g. a third-party evaluator, community members, beneficiaries | `org.hypercerts.context.evaluation` |
5555

5656
### Additional notes
5757

public/raw/getting-started/working-with-evaluations.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ await agent.login({
2121
// Create an evaluation of an activity claim
2222
const evaluation = await agent.com.atproto.repo.createRecord({
2323
repo: agent.session.did,
24-
collection: "org.hypercerts.claim.evaluation",
24+
collection: "org.hypercerts.context.evaluation",
2525
record: {
2626
subject: {
2727
uri: "at://did:plc:xyz789/org.hypercerts.claim.activity/3k2j4h5g6f7d8s9a",
2828
cid: "bafyreiabc123...",
2929
},
3030
evaluators: ["did:plc:evaluator123"],
3131
summary: "Verified documentation updates. All 15 examples tested and working. High quality contribution with clear impact on developer experience.",
32-
$type: "org.hypercerts.claim.evaluation",
32+
$type: "org.hypercerts.context.evaluation",
3333
createdAt: new Date().toISOString(),
3434
},
3535
});
@@ -46,7 +46,7 @@ Measurements provide quantitative data that supports your evaluation:
4646
```typescript
4747
const measurement = await agent.com.atproto.repo.createRecord({
4848
repo: agent.session.did,
49-
collection: "org.hypercerts.claim.measurement",
49+
collection: "org.hypercerts.context.measurement",
5050
record: {
5151
subject: {
5252
uri: "at://did:plc:xyz789/org.hypercerts.claim.activity/3k2j4h5g6f7d8s9a",
@@ -60,7 +60,7 @@ const measurement = await agent.com.atproto.repo.createRecord({
6060
methodURI: "https://example.com/analytics-methodology",
6161
evidenceURI: ["https://example.com/analytics-report.pdf"],
6262
comment: "Page view data collected over the first 30 days after publication.",
63-
$type: "org.hypercerts.claim.measurement",
63+
$type: "org.hypercerts.context.measurement",
6464
createdAt: new Date().toISOString(),
6565
},
6666
});

public/raw/tools/scaffold.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -180,9 +180,9 @@ ATProto has no built-in reverse lookup — given a hypercert URI, there is no na
180180

181181
Constellation indexes ATProto records and returns all records that reference a given subject URI. The scaffold queries three source paths:
182182

183-
- Attachments: `org.hypercerts.claim.attachment:subjects[com.atproto.repo.strongRef].uri`
184-
- Evaluations: `org.hypercerts.claim.evaluation:subject.uri`
185-
- Measurements: `org.hypercerts.claim.measurement:subject.uri`
183+
- Attachments: `org.hypercerts.context.attachment:subjects[com.atproto.repo.strongRef].uri`
184+
- Evaluations: `org.hypercerts.context.evaluation:subject.uri`
185+
- Measurements: `org.hypercerts.context.measurement:subject.uri`
186186

187187
The query hooks follow a two-step pattern: fetch backlink URIs from Constellation, then fetch each record's full data via Server Actions. This split is necessary because Constellation returns record identifiers, not record contents.
188188

@@ -294,4 +294,4 @@ hypercerts-scaffold/
294294
└── vendor/ # Packed dependency tarballs (pre-release)
295295
```
296296

297-
`app/` contains pages (server components by default) and API routes. `lib/` is split: top-level files are server-only, while `lib/api/` is the client-side fetch layer that browser code calls. `providers/` has one server component (`SignedInProvider`, which handles the auth gate and renders the Navbar) and one client component (`AllProviders`, which sets up the TanStack Query client). `queries/` is entirely client-side TanStack Query hooks. `components/` is entirely client-side React components.
297+
`app/` contains pages (server components by default) and API routes. `lib/` is split: top-level files are server-only, while `lib/api/` is the client-side fetch layer that browser code calls. `providers/` has one server component (`SignedInProvider`, which handles the auth gate and renders the Navbar) and one client component (`AllProviders`, which sets up the TanStack Query client). `queries/` is entirely client-side TanStack Query hooks. `components/` is entirely client-side React components.

0 commit comments

Comments
 (0)