docs: rename CEL Work Scopes → Work Scopes, trim and restructure#66
docs: rename CEL Work Scopes → Work Scopes, trim and restructure#66s-adamantine wants to merge 3 commits intomainfrom
Conversation
…, add simple case
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughDocumentation rewrite of the Work Scopes page reorganizes content to emphasize simple string lists alongside structured CEL usage, introduces a "simple case" JSON example, replaces code examples with narrative descriptions, and updates vocabulary examples and planning status notes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/core-concepts/work-scopes.md`:
- Around line 8-17: Normalize the documentation and examples so the `workScope`
simple variant and the union schema match: pick one canonical simple shape
(either a plain array of strings like `"workScope": ["Documentation","Open
Source"]` or an object with `allOf`) and update the example block and
descriptive text to use that exact form; alternatively, explicitly list all
accepted variants and their exact schemas, referencing the union member names
`workScopeString` and the structured CEL variant (e.g., `workScopeCEL`/`allOf`)
and show one concrete example for each so clients can implement the union
correctly.
pages/core-concepts/work-scopes.md
Outdated
| Work scopes describe what work a hypercert covers. Every activity claim has a `workScope` field that can be either a simple string list or a structured CEL expression for machine-evaluable logic. | ||
|
|
||
| [CEL (Common Expression Language)](https://github.com/google/cel-spec) is an open-source expression language built by Google for evaluating conditions in distributed systems. It's used by Kubernetes, Firebase, and Google Cloud IAM. | ||
| ## The simple case | ||
|
|
||
| ## Why structured scopes matter | ||
| Most hypercerts use a simple string list for work scopes: | ||
|
|
||
| A community in coastal Kenya mints a hypercert for "mangrove restoration and environmental education." A collective in Uganda creates one for "agroforestry with beekeeping." A drone operator in the Amazon documents "biodiversity monitoring in the Negro River region." These are all legible to a person reading them one at a time. They're invisible to any system trying to connect funders to relevant work at scale. | ||
| ```json | ||
| { | ||
| "workScope": { "allOf": ["Documentation", "Open Source"] } | ||
| } |
There was a problem hiding this comment.
Align workScope shape terminology with the union schema.
Line 8/12 says “simple string list,” Lines 14-17 show an allOf object, and Lines 90-94 define workScopeString as free-form string. These three representations conflict and can cause incorrect client implementations. Please normalize wording/examples to one canonical simple variant (or explicitly document all accepted variants and their exact schema).
Also applies to: 90-94
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@pages/core-concepts/work-scopes.md` around lines 8 - 17, Normalize the
documentation and examples so the `workScope` simple variant and the union
schema match: pick one canonical simple shape (either a plain array of strings
like `"workScope": ["Documentation","Open Source"]` or an object with `allOf`)
and update the example block and descriptive text to use that exact form;
alternatively, explicitly list all accepted variants and their exact schemas,
referencing the union member names `workScopeString` and the structured CEL
variant (e.g., `workScopeCEL`/`allOf`) and show one concrete example for each so
clients can implement the union correctly.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
1 participant
Summary
cel-work-scopes.md→work-scopes.md, updates nav and frontmatterallOfstring list) since that's what most users will use todaycertified.ink→certified.appSummary by CodeRabbit