okf 2.0.0 → 2.1.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +27 -0
- data/README.md +9 -5
- data/lib/okf/cli.rb +20 -2
- data/lib/okf/skill/SKILL.md +15 -7
- data/lib/okf/skill/playbooks/maintain.md +3 -1
- data/lib/okf/skill/playbooks/produce.md +4 -2
- data/lib/okf/skill/reference/authoring.md +23 -26
- data/lib/okf/skill/reference/cli/checks.md +171 -0
- data/lib/okf/skill/reference/cli/graph.md +49 -0
- data/lib/okf/skill/reference/cli/map.md +98 -0
- data/lib/okf/skill/reference/cli/registry.md +70 -0
- data/lib/okf/skill/reference/cli/search.md +130 -0
- data/lib/okf/skill/reference/cli/serve.md +83 -0
- data/lib/okf/skill/reference/cli/views.md +59 -0
- data/lib/okf/skill/reference/cli.md +33 -603
- data/lib/okf/skill/reference/spec-map.md +32 -0
- data/lib/okf/version.rb +1 -1
- metadata +9 -1
|
@@ -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
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.
|
|
4
|
+
version: 2.1.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Rodrigo Serradura
|
|
@@ -146,6 +146,14 @@ files:
|
|
|
146
146
|
- lib/okf/skill/reference/SPEC.md
|
|
147
147
|
- lib/okf/skill/reference/authoring.md
|
|
148
148
|
- lib/okf/skill/reference/cli.md
|
|
149
|
+
- lib/okf/skill/reference/cli/checks.md
|
|
150
|
+
- lib/okf/skill/reference/cli/graph.md
|
|
151
|
+
- lib/okf/skill/reference/cli/map.md
|
|
152
|
+
- lib/okf/skill/reference/cli/registry.md
|
|
153
|
+
- lib/okf/skill/reference/cli/search.md
|
|
154
|
+
- lib/okf/skill/reference/cli/serve.md
|
|
155
|
+
- lib/okf/skill/reference/cli/views.md
|
|
156
|
+
- lib/okf/skill/reference/spec-map.md
|
|
149
157
|
- lib/okf/skill/templates/attested-computation.md
|
|
150
158
|
- lib/okf/skill/templates/concept.md
|
|
151
159
|
- lib/okf/skill/templates/index.md
|