Skip to content

Commit a56bfd4

Browse files
committed
docs(universal): Add links to external implementations
1 parent 4175055 commit a56bfd4

5 files changed

Lines changed: 75 additions & 27 deletions

File tree

README.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Read the following documents, in this order, before the rest:
2222
1. **[Dream](https://thumbrise.github.io/op/books/dream/)** — a short book. No technical words. Start here if you want to understand what this is about before reading anything else.
2323
2. **[ACKNOWLEDGEMENTS](https://thumbrise.github.io/op/ACKNOWLEDGEMENTS)** — every person, project, and discipline this work stands on. Standing on the shoulders of the founders. Respect comes first.
2424
3. **[FAQ](https://thumbrise.github.io/op/FAQ)** — how this repository is meant to be read, what is and is not being claimed, common misreadings, common technical objections.
25-
4. **The rest of this README, the devlogs, and the materials** — what we found, after the credit and the framing are in place.
25+
4. **The rest of this README, the notes, and the materials** — what we found, after the credit and the framing are in place.
2626

2727
## Why this exists
2828

@@ -36,8 +36,8 @@ Op tries to name the form on its own — without the transport, without the lang
3636

3737
Op (Operation Protocol) is a formalization of the operation as a universal primitive:
3838

39-
- **Five fields**`id`, `comment`, `input`, `output`, `errors` — describe any operation at any level. Not an opinion. A fact. Like Church's lambda calculus formalized computation in 1936.
40-
- **Traits** — namespaced key-value extensions attached from outside. HTTP routes, gRPC services, authentication, CLI flags. The operation does not change when a trait is added or removed. Traits are opinions. The operation is the fact.
39+
- **Five fields**`id`, `comment`, `input`, `output`, `error` — describe any operation at any level. Not an opinion. A fact. Like Church's lambda calculus formalized computation in 1936.
40+
- **Traits** — namespaced extensions attached from outside. HTTP routes, gRPC services, authentication, CLI flags. The operation does not change when a trait is added or removed. Traits are opinions. The operation is the fact.
4141
- **Instructions** — versioned, fully resolved units that flow between **emitters** (DSL compilers, scrapers, handwritten JSON) and **receivers** (framework compilers, documentation portals, AI tool registries, security scanners) through any transport.
4242

4343
**N + M instead of N × M.** New emitter — all receivers for free. New receiver — all emitters for free. The economics of LLVM applied one floor higher.
@@ -66,7 +66,7 @@ The theory predicts that one instruction format can replace N×M integrations wi
6666
- [ ] **Validation** — a schema-level proof that every instruction conforms to the five-field structure. Invalid input → precise error. The contract is machine-enforceable
6767
- [ ] **Formal specification** — RFC, JSON Schema versioned and frozen. The protocol is citable, auditable, and forkable
6868

69-
## Forget everything above
69+
## Anti-CTA
7070

7171
Lists. Diagrams. Five fields. The PoC checklist.
7272
All of it true. None of it the point.
@@ -78,18 +78,32 @@ The goal is not to remove boilerplate. The goal is for programs to
7878
understand each other's capabilities. The consequences run wider than
7979
what we can list today.
8080

81-
If you read this far you are not a user. You are an early hand.
81+
If you read this far - you are not a user. You are an early hand.
8282
What is below is for those who want to understand.
8383

84-
- [The Notes: form of operation](https://thumbrise.github.io/op/notes/form-of-operation/) — how the form was found.
85-
- [The Conjecture](https://thumbrise.github.io/op/reference/the-primitive-range-conjecture) — the law that holds it.
86-
- [Dream](https://thumbrise.github.io/op/books/dream/) — a book about a world where it worked.
87-
- [The Schema Of Instruction](https://thumbrise.github.io/op/reference/instruction.v1.json) — the form of instruction. (WIP)
88-
- [The Schema Of Operation](https://thumbrise.github.io/op/reference/operation.v1.json) — the form of Operation itself.
89-
9084
There is no «Get Started» button here. Op is not for sale.
9185
Op either surfaces in you on its own — or it does not.
9286

87+
### The forms
88+
89+
- [The Schema Of Instruction](https://thumbrise.github.io/op/reference/instruction.v1.json)
90+
- [The Schema Of Nota](https://thumbrise.github.io/op/reference/nota.v1.json)
91+
- [The Schema Of Data Rail](https://thumbrise.github.io/op/reference/rail.v1.json)
92+
- [The Schema Of Operation](https://thumbrise.github.io/op/reference/operation.v1.json)
93+
94+
### How the forms were found
95+
96+
- [The Notes: form of Instruction](https://thumbrise.github.io/op/notes/form-of-instruction/)
97+
- [The Notes: form of Nota](https://thumbrise.github.io/op/notes/form-of-nota/)
98+
- [The Notes: form of Data Rail](https://thumbrise.github.io/op/notes/form-of-rail/)
99+
- [The Notes: form of Operation](https://thumbrise.github.io/op/notes/form-of-operation/)
100+
101+
### Misc
102+
103+
- [Dream](https://thumbrise.github.io/op/books/dream/) — a book about a world where it worked.
104+
- [The Conjecture](https://thumbrise.github.io/op/reference/the-primitive-range-conjecture) — the law that holds it.
105+
- [Operation Protocol RFC](https://thumbrise.github.io/op/reference/rfc-operation-protocol.md) - request for comments.
106+
93107
## License
94108

95109
[Apache 2.0](LICENSE)

docs/idea.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -446,14 +446,9 @@ Every service describes itself. `any://any.com/operations/` — and in the respo
446446

447447
**The developer never sees Op.** Like you never see TCP when you open Gmail. The protocol is invisible. Vendors compile from instructions — their reputation depends on the quality. The developer writes business logic. Everything else is compiled.
448448

449-
## The Schema
449+
## Anti-CTA
450450

451-
- [The Schema Of Instruction](reference/instruction.v1.json) — the form of instruction. (WIP)
452-
- [The Schema Of Operation](reference/operation.v1.json) — the form of Operation itself.
453-
454-
## Forget everything above
455-
456-
Lists. Diagrams. Forty-nine systems. Seven unlocks.
451+
Lists. Diagrams. Five fields. The PoC checklist.
457452
All of it true. None of it the point.
458453

459454
Op is not an optimization. Op is a form. Found through long subtractions.
@@ -463,11 +458,28 @@ The goal is not to remove boilerplate. The goal is for programs to
463458
understand each other's capabilities. The consequences run wider than
464459
what we can list today.
465460

466-
If you read this far you are not a user. You are an early hand.
461+
If you read this far - you are not a user. You are an early hand.
467462
What is below is for those who want to understand.
468463

469-
- [The Notes: form of operation](/notes/form-of-operation/) — how the form was found.
470-
- [The Conjecture](/reference/the-primitive-range-conjecture) — the law that holds it.
471-
- [Dream](/books/dream/) — a book about a world where it worked.
472-
- [The Schema Of Instruction](reference/instruction.v1.json) — the form of instruction. (WIP)
473-
- [The Schema Of Operation](reference/operation.v1.json) — the form of Operation itself.
464+
There is no «Get Started» button here. Op is not for sale.
465+
Op either surfaces in you on its own — or it does not.
466+
467+
### The forms
468+
469+
- [The Schema Of Instruction](https://thumbrise.github.io/op/reference/instruction.v1.json)
470+
- [The Schema Of Nota](https://thumbrise.github.io/op/reference/nota.v1.json)
471+
- [The Schema Of Data Rail](https://thumbrise.github.io/op/reference/rail.v1.json)
472+
- [The Schema Of Operation](https://thumbrise.github.io/op/reference/operation.v1.json)
473+
474+
### How the forms were found
475+
476+
- [The Notes: form of Instruction](https://thumbrise.github.io/op/notes/form-of-instruction/)
477+
- [The Notes: form of Nota](https://thumbrise.github.io/op/notes/form-of-nota/)
478+
- [The Notes: form of Data Rail](https://thumbrise.github.io/op/notes/form-of-rail/)
479+
- [The Notes: form of Operation](https://thumbrise.github.io/op/notes/form-of-operation/)
480+
481+
### Misc
482+
483+
- [Dream](https://thumbrise.github.io/op/books/dream/) — a book about a world where it worked.
484+
- [The Conjecture](https://thumbrise.github.io/op/reference/the-primitive-range-conjecture) — the law that holds it.
485+
- [Operation Protocol RFC](https://thumbrise.github.io/op/reference/rfc-operation-protocol.md) - request for comments.

docs/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,5 @@ Read the following documents, in this order, before the rest:
2525

2626
If you want to see the technical picture — the problems, the solution, the diagrams — see [The Idea](/idea).
2727

28-
- [The Schema Of Instruction](reference/instruction.v1.json) — the form of instruction. (WIP)
29-
- [The Schema Of Operation](reference/operation.v1.json) — the form of Operation itself.
30-
3128
There is no «Get Started» button here. Op is not for sale.
3229
Op either surfaces in you on its own — or it does not.

universal/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
# universal/ — first vendors, not a standard library
2+
<details>
3+
<summary>
4+
Warning
5+
</summary>
6+
This content may be stale. See the Appended section below.
7+
</details>
28

39
This directory holds the vendors we are bootstrapping for Op. They are not a standard library. They are the first inhabitants of an otherwise empty world, written so that instructions have somewhere to land while the protocol gets its legs.
410

@@ -19,3 +25,15 @@ It is also not a contract that the vendors we ship will be the best ones. Our su
1925
- [`ROADMAP.md`](./ROADMAP.md) — what we plan to build inside `universal/` next.
2026
- [Devlog #28](../docs/notes/form-of-operation/028-dobby-is-free.md) — why this directory exists at all.
2127
- [Devlog #29](../docs/notes/form-of-operation/029-the-anthill-organizes.md) — why we do not plan beyond the horizon of real need.
28+
29+
## Appended
30+
31+
Many implementations were moved to personal repos.
32+
33+
| Name | Link |
34+
|--------------------------------|-----------------------------------------------------------|
35+
| Universal Schema (Golang) | https://github.com/thumbrise/op-universal-schema-go |
36+
| Universal Schema (PHP) | https://github.com/thumbrise/op-universal-schema-php |
37+
| HTTP universal vendor | https://github.com/thumbrise/op-universal-vendor-http |
38+
| HTTP universal vendor (Golang) | https://github.com/thumbrise/op-universal-vendor-http-go |
39+
| HTTP universal vendor (PHP) | https://github.com/thumbrise/op-universal-vendor-http-php |

universal/ROADMAP.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# universal/ — roadmap
22

3+
<details>
4+
<summary>
5+
Warning
6+
</summary>
7+
This content may be stale.
8+
</details>
9+
310
What we plan to build next inside `universal/`. Not a contract. A direction.
411

512
Each milestone is a verifiable state of the world, not a category of work. A milestone closes when someone from the outside can run it and observe the result.

0 commit comments

Comments
 (0)