okf 2.0.0 → 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. checksums.yaml +4 -4
  2. data/.okf/capabilities/agent-skill.md +112 -0
  3. data/.okf/capabilities/bundles-manager.md +133 -0
  4. data/.okf/capabilities/graph-server.md +678 -0
  5. data/.okf/capabilities/index.md +26 -0
  6. data/.okf/capabilities/library-api.md +82 -0
  7. data/.okf/capabilities/linter.md +83 -0
  8. data/.okf/capabilities/read-views.md +228 -0
  9. data/.okf/capabilities/render.md +66 -0
  10. data/.okf/capabilities/search.md +295 -0
  11. data/.okf/capabilities/validator.md +60 -0
  12. data/.okf/cli.md +193 -0
  13. data/.okf/design/browser-tests.md +211 -0
  14. data/.okf/design/core-shell-split.md +73 -0
  15. data/.okf/design/index.md +17 -0
  16. data/.okf/design/integration-first.md +140 -0
  17. data/.okf/design/packaging.md +65 -0
  18. data/.okf/design/ruby-floor.md +53 -0
  19. data/.okf/design/runtime-dependencies.md +82 -0
  20. data/.okf/design/search-engines.md +154 -0
  21. data/.okf/design/server-trust-boundary.md +139 -0
  22. data/.okf/index.md +40 -0
  23. data/.okf/log.md +662 -0
  24. data/.okf/model/bundle.md +47 -0
  25. data/.okf/model/concept.md +75 -0
  26. data/.okf/model/graph.md +59 -0
  27. data/.okf/model/index.md +9 -0
  28. data/.okf/model/skeleton.md +76 -0
  29. data/.okf/overview.md +87 -0
  30. data/.okf/registry.md +265 -0
  31. data/.okf/structure/format-layer.md +59 -0
  32. data/.okf/structure/index.md +22 -0
  33. data/.okf/structure/search.md +53 -0
  34. data/.okf/structure/the-analysers.md +60 -0
  35. data/.okf/structure/the-cli.md +99 -0
  36. data/.okf/structure/the-disk-shell.md +67 -0
  37. data/.okf/structure/the-model.md +81 -0
  38. data/.okf/structure/the-server.md +74 -0
  39. data/.okf/structure/the-skill.md +52 -0
  40. data/.okf/testing/adding-a-verb.md +76 -0
  41. data/.okf/testing/index.md +12 -0
  42. data/.okf/testing/the-harness.md +45 -0
  43. data/CHANGELOG.md +83 -16
  44. data/README.md +205 -21
  45. data/lib/okf/cli.rb +20 -2
  46. data/lib/okf/skill/SKILL.md +15 -7
  47. data/lib/okf/skill/playbooks/maintain.md +3 -1
  48. data/lib/okf/skill/playbooks/produce.md +4 -2
  49. data/lib/okf/skill/reference/authoring.md +23 -26
  50. data/lib/okf/skill/reference/cli/checks.md +171 -0
  51. data/lib/okf/skill/reference/cli/graph.md +49 -0
  52. data/lib/okf/skill/reference/cli/map.md +98 -0
  53. data/lib/okf/skill/reference/cli/registry.md +70 -0
  54. data/lib/okf/skill/reference/cli/search.md +130 -0
  55. data/lib/okf/skill/reference/cli/serve.md +83 -0
  56. data/lib/okf/skill/reference/cli/views.md +59 -0
  57. data/lib/okf/skill/reference/cli.md +33 -603
  58. data/lib/okf/skill/reference/spec-map.md +32 -0
  59. data/lib/okf/version.rb +1 -1
  60. metadata +54 -5
@@ -0,0 +1,32 @@
1
+ # What each SPEC section governs
2
+
3
+ Kind: index. Answers: which § of the vendored spec settles a question, so you
4
+ consult one section instead of re-reading all of [SPEC.md](SPEC.md).
5
+
6
+ The spec is vendored **verbatim** from upstream — its header names the commit
7
+ and the licence — so it is never edited here and never split; this file is its
8
+ map, kept beside it. The § numbers are the stable keys: cite `§6.2`, never a
9
+ heading or a line number. Every section is here, including the two an authoring
10
+ question rarely reaches: an index that quietly drops what it judges uninteresting
11
+ misroutes the reader who wanted exactly that. <!-- rule:okf-spec-map -->
12
+
13
+ | § | Governs | Reach for it when |
14
+ |---|---------|-------------------|
15
+ | §1 | motivation, goals, and the **non-goals** | arguing why OKF at all; checking a proposal against what the format refuses to be |
16
+ | §2 | terminology — bundle, concept, concept ID, frontmatter, body, link, source, provenance, credibility signal, actor, trust tier, attested computation, executor, receipt, attester | a word is load-bearing in a disagreement, or a field name reads two ways |
17
+ | §3 | bundle structure, reserved filenames | laying out directories |
18
+ | §4 | concept documents & frontmatter | writing or validating a concept |
19
+ | §5.1 | provenance — `sources` and its credibility signals | any external or empirical claim |
20
+ | §5.2 / §5.3 | trust — `generated`, `verified`, and the derived tiers | recording who wrote or confirmed content |
21
+ | §5.4 / §5.5 | lifecycle — `status`, `stale_after` | marking drafts, deprecations, expiries |
22
+ | §6 / §6.1 | cross-links; **broken links are tolerated** | linking; judging a "broken" link |
23
+ | §6.2 / §6.3 | path-valued fields; the `references/` convention | pointing at non-concept assets |
24
+ | §7 | the actor convention | filling any `by` |
25
+ | §8 | index files & progressive disclosure | orienting; writing or synthesizing an index |
26
+ | §9 | log files | recording history |
27
+ | §10 | attested computations | a concept that *is* a sanctioned computation |
28
+ | §11 | conformance — the hard gate | what `validate` may and may not reject |
29
+ | §12 | versioning (`okf_version`) | the root index's one allowed field |
30
+ | §13 | changes from v0.1 | migrating a bundle; reading an unmigrated one |
31
+ | Appendix A | one worked bundle exercising every family, as a v0.1 → v0.2 migration | you want the whole shape at once rather than a rule at a time |
32
+
data/lib/okf/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module OKF
4
- VERSION = "2.0.0"
4
+ VERSION = "2.1.1"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: okf
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.0.0
4
+ version: 2.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Rodrigo Serradura
@@ -77,6 +77,47 @@ executables:
77
77
  extensions: []
78
78
  extra_rdoc_files: []
79
79
  files:
80
+ - ".okf/capabilities/agent-skill.md"
81
+ - ".okf/capabilities/bundles-manager.md"
82
+ - ".okf/capabilities/graph-server.md"
83
+ - ".okf/capabilities/index.md"
84
+ - ".okf/capabilities/library-api.md"
85
+ - ".okf/capabilities/linter.md"
86
+ - ".okf/capabilities/read-views.md"
87
+ - ".okf/capabilities/render.md"
88
+ - ".okf/capabilities/search.md"
89
+ - ".okf/capabilities/validator.md"
90
+ - ".okf/cli.md"
91
+ - ".okf/design/browser-tests.md"
92
+ - ".okf/design/core-shell-split.md"
93
+ - ".okf/design/index.md"
94
+ - ".okf/design/integration-first.md"
95
+ - ".okf/design/packaging.md"
96
+ - ".okf/design/ruby-floor.md"
97
+ - ".okf/design/runtime-dependencies.md"
98
+ - ".okf/design/search-engines.md"
99
+ - ".okf/design/server-trust-boundary.md"
100
+ - ".okf/index.md"
101
+ - ".okf/log.md"
102
+ - ".okf/model/bundle.md"
103
+ - ".okf/model/concept.md"
104
+ - ".okf/model/graph.md"
105
+ - ".okf/model/index.md"
106
+ - ".okf/model/skeleton.md"
107
+ - ".okf/overview.md"
108
+ - ".okf/registry.md"
109
+ - ".okf/structure/format-layer.md"
110
+ - ".okf/structure/index.md"
111
+ - ".okf/structure/search.md"
112
+ - ".okf/structure/the-analysers.md"
113
+ - ".okf/structure/the-cli.md"
114
+ - ".okf/structure/the-disk-shell.md"
115
+ - ".okf/structure/the-model.md"
116
+ - ".okf/structure/the-server.md"
117
+ - ".okf/structure/the-skill.md"
118
+ - ".okf/testing/adding-a-verb.md"
119
+ - ".okf/testing/index.md"
120
+ - ".okf/testing/the-harness.md"
80
121
  - CHANGELOG.md
81
122
  - LICENSE.txt
82
123
  - NOTICE
@@ -146,20 +187,28 @@ files:
146
187
  - lib/okf/skill/reference/SPEC.md
147
188
  - lib/okf/skill/reference/authoring.md
148
189
  - lib/okf/skill/reference/cli.md
190
+ - lib/okf/skill/reference/cli/checks.md
191
+ - lib/okf/skill/reference/cli/graph.md
192
+ - lib/okf/skill/reference/cli/map.md
193
+ - lib/okf/skill/reference/cli/registry.md
194
+ - lib/okf/skill/reference/cli/search.md
195
+ - lib/okf/skill/reference/cli/serve.md
196
+ - lib/okf/skill/reference/cli/views.md
197
+ - lib/okf/skill/reference/spec-map.md
149
198
  - lib/okf/skill/templates/attested-computation.md
150
199
  - lib/okf/skill/templates/concept.md
151
200
  - lib/okf/skill/templates/index.md
152
201
  - lib/okf/skill/templates/log.md
153
202
  - lib/okf/skill/templates/root-index.md
154
203
  - lib/okf/version.rb
155
- homepage: https://github.com/serradura/okf-gem
204
+ homepage: https://github.com/serradura/okf
156
205
  licenses:
157
206
  - Apache-2.0
158
207
  metadata:
159
208
  allowed_push_host: https://rubygems.org
160
- homepage_uri: https://github.com/serradura/okf-gem
161
- source_code_uri: https://github.com/serradura/okf-gem
162
- changelog_uri: https://github.com/serradura/okf-gem/blob/main/okf/CHANGELOG.md
209
+ homepage_uri: https://github.com/serradura/okf
210
+ source_code_uri: https://github.com/serradura/okf
211
+ changelog_uri: https://github.com/serradura/okf/blob/main/gems/okf/CHANGELOG.md
163
212
  rubygems_mfa_required: 'true'
164
213
  rdoc_options: []
165
214
  require_paths: