docs: rebuild GUL README as developer landing page - #24
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: da85bb8b80
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ``` | ||
|
|
||
| --- | ||
| Missing fact bindings defer rather than fabricate certainty. Explicit mismatches deny. |
There was a problem hiding this comment.
Clarify which missing facts defer
This overstates the atom semantics for fact environments: FactEnvironment.evaluate_predicate only defers missing role/attribute maps and missing custom keys, while absent belongs_to and in_context relations return DENY (facts.py lines 116-128). Users writing membership/context policies from this README could omit a relation expecting escalation, but the runtime will produce an authoritative denial instead.
Useful? React with 👍 / 👎.


Summary
Rebuilds the repository README as a focused developer landing page while preserving access to the previous full v2.2 reference through a permanent commit link.
What changed
Why
The previous README was technically comprehensive but front-loaded theory and exposed the practical value too late. This revision reduces evaluation friction for engineers discovering the project while retaining formal precision and truthful implementation-status claims.
Validation
Documentation-only change.
Verified against:
pyproject.tomlfor package name, version, Python support, license, and dependency claims;.github/workflows/runtime-ci.ymlfor the Python 3.10–3.13 test matrix and smoke commands;cpp/CMakeLists.txtfor C++17 and native build details;examples/specs/basic_infer.gul.jsonandtests/golden/basic_infer.infer.jsonfor the quick-start example and stable output;docs/runtime_usage.mdfor runtime boundaries, fallback behavior, fact semantics, supported tags, and dataset constraints.No runtime code, schemas, tests, or build configuration were changed.