@panaversity/ksor 0.0.39 → 0.0.41
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.
- package/CHANGELOG.md +965 -0
- package/README.md +29 -9
- package/dist/checker/check-main.mjs +14049 -0
- package/dist/cli.mjs +11528 -5213
- package/dist/gateway-api-CF4ED9_g-BQusM_dK.mjs +10895 -0
- package/dist/gateway.d.mts +52 -13
- package/dist/gateway.mjs +2 -2
- package/dist/index.d.mts +1 -1
- package/dist/index.mjs +1 -1
- package/dist/{src-pl4aOpVs.mjs → src-dqpI-p1a.mjs} +1 -0
- package/docs/authorization.md +8 -6
- package/docs/deploying.md +36 -25
- package/docs/index.md +26 -13
- package/docs/ingesting.md +70 -22
- package/docs/tool-surface.md +69 -16
- package/package.json +4 -3
- package/schema/migrations/2.4-2.5__okf-profile.sql +114 -0
- package/schema/schema.sql +77 -14
- package/templates/scaffold/.agents/skills/add-sources/SKILL.md +63 -18
- package/templates/scaffold/.agents/skills/format-checker/SKILL.md +42 -33
- package/templates/scaffold/.agents/skills/format-checker/check.mjs +13827 -1314
- package/templates/scaffold/.agents/skills/intake-interview/SKILL.md +65 -27
- package/templates/scaffold/.agents/skills/make-slides/SKILL.md +7 -5
- package/templates/scaffold/.agents/skills/make-summary/SKILL.md +13 -6
- package/templates/scaffold/.claude/skills/add-sources/SKILL.md +63 -18
- package/templates/scaffold/.claude/skills/format-checker/SKILL.md +42 -33
- package/templates/scaffold/.claude/skills/format-checker/check.mjs +13827 -1314
- package/templates/scaffold/.claude/skills/intake-interview/SKILL.md +65 -27
- package/templates/scaffold/.claude/skills/make-slides/SKILL.md +7 -5
- package/templates/scaffold/.claude/skills/make-summary/SKILL.md +13 -6
- package/templates/scaffold/.github/workflows/validate.yml +9 -1
- package/templates/scaffold/.ksor/governance.yaml +17 -0
- package/templates/scaffold/AGENTS.md +293 -119
- package/templates/scaffold/Dockerfile +5 -1
- package/templates/scaffold/README.md +160 -42
- package/templates/scaffold/env.example +37 -6
- package/templates/scaffold/gitignore +14 -6
- package/templates/scaffold/instance.md +21 -17
- package/templates/scaffold/knowledge/governance-ladder.md +11 -2
- package/templates/scaffold/knowledge/index.md +9 -0
- package/templates/scaffold/knowledge/surfaces/for-agents.md +13 -6
- package/templates/scaffold/knowledge/surfaces/for-people.md +7 -6
- package/templates/scaffold/knowledge/surfaces/index.md +4 -20
- package/templates/scaffold/knowledge/surfaces/overview.md +25 -0
- package/templates/scaffold/knowledge/what-is-a-ksor.md +6 -5
- package/templates/scaffold/knowledge/what-is-a-ksor.summary.md +4 -0
- package/templates/scaffold/package.json +3 -4
- package/templates/scaffold/pnpm-lock.yaml +3 -0
- package/templates/scaffold/system/gateways/content.ts +13 -0
- package/templates/scaffold/system/site/app/(home)/page.tsx +2 -2
- package/templates/scaffold/system/site/app/.well-known/mcp/server.json/route.ts +10 -0
- package/templates/scaffold/system/site/app/docs/[[...slug]]/page.tsx +134 -91
- package/templates/scaffold/system/site/app/global.css +198 -6
- package/templates/scaffold/system/site/app/layout.tsx +8 -3
- package/templates/scaffold/system/site/app/llms-full.txt/route.ts +13 -7
- package/templates/scaffold/system/site/app/llms.txt/route.ts +12 -7
- package/templates/scaffold/system/site/app/md/[[...slug]]/route.ts +26 -25
- package/templates/scaffold/system/site/components/code-block.tsx +87 -0
- package/templates/scaffold/system/site/components/embed.tsx +276 -0
- package/templates/scaffold/system/site/components/footer-mark.tsx +3 -2
- package/templates/scaffold/system/site/components/governance.tsx +219 -87
- package/templates/scaffold/system/site/components/mdx.tsx +10 -2
- package/templates/scaffold/system/site/components/record-index.tsx +5 -5
- package/templates/scaffold/system/site/components/record-stack.tsx +10 -9
- package/templates/scaffold/system/site/components/record-views.tsx +6 -17
- package/templates/scaffold/system/site/components/sidebar-status.tsx +19 -18
- package/templates/scaffold/system/site/lib/alert-rule.ts +214 -0
- package/templates/scaffold/system/site/lib/attachment-rule.ts +6 -1
- package/templates/scaffold/system/site/lib/attachments.ts +0 -28
- package/templates/scaffold/system/site/lib/audience-rule.ts +15 -21
- package/templates/scaffold/system/site/lib/audience.ts +42 -146
- package/templates/scaffold/system/site/lib/embed-rule.ts +255 -0
- package/templates/scaffold/system/site/lib/governance.ts +339 -225
- package/templates/scaffold/system/site/lib/index-routes.ts +125 -0
- package/templates/scaffold/system/site/lib/lifecycle-rule.ts +52 -0
- package/templates/scaffold/system/site/lib/lock.ts +282 -0
- package/templates/scaffold/system/site/lib/order-rule.ts +37 -0
- package/templates/scaffold/system/site/lib/record-href.ts +68 -0
- package/templates/scaffold/system/site/lib/record-link.tsx +26 -0
- package/templates/scaffold/system/site/lib/rules-version.ts +11 -0
- package/templates/scaffold/system/site/lib/shared.ts +67 -104
- package/templates/scaffold/system/site/lib/sim-rule.ts +49 -0
- package/templates/scaffold/system/site/lib/source.ts +256 -186
- package/templates/scaffold/system/site/lib/stage-knowledge.ts +638 -467
- package/templates/scaffold/system/site/lib/stage-manifest.ts +128 -0
- package/templates/scaffold/system/site/package.json +1 -0
- package/templates/scaffold/system/site/record/actor.ts +23 -0
- package/templates/scaffold/system/site/record/check.ts +571 -0
- package/templates/scaffold/system/site/record/citations.ts +312 -0
- package/templates/scaffold/system/site/record/frontmatter.ts +134 -0
- package/templates/scaffold/system/site/record/git-ledger.ts +171 -0
- package/templates/scaffold/system/site/record/hygiene.ts +320 -0
- package/templates/scaffold/system/site/record/index-file.ts +150 -0
- package/templates/scaffold/system/site/record/index.ts +103 -0
- package/templates/scaffold/system/site/record/instance.ts +257 -0
- package/templates/scaffold/system/site/record/instant.ts +43 -0
- package/templates/scaffold/system/site/record/ledger.ts +694 -0
- package/templates/scaffold/system/site/record/load.ts +129 -0
- package/templates/scaffold/system/site/record/lock.ts +306 -0
- package/templates/scaffold/system/site/record/near-miss.ts +37 -0
- package/templates/scaffold/system/site/record/policy.ts +414 -0
- package/templates/scaffold/system/site/record/profile.ts +535 -0
- package/templates/scaffold/system/site/record/refusal.ts +106 -0
- package/templates/scaffold/system/site/record/yaml-file.ts +103 -0
- package/templates/scaffold/system/site/source.config.ts +109 -23
- package/dist/gateway-api-CmIthmJS-IUA9qS-T.mjs +0 -3225
- package/templates/scaffold/system/site/lib/denial-rule.ts +0 -220
- package/templates/scaffold/system/site/lib/page-order.ts +0 -93
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ when the corpus does not cover the question.
|
|
|
10
10
|
## Start
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
npx @panaversity/ksor init my-sor
|
|
13
|
+
npx @panaversity/ksor@latest init my-sor
|
|
14
14
|
cd my-sor
|
|
15
15
|
pnpm install
|
|
16
16
|
pnpm dev # the site, live at http://localhost:3000
|
|
@@ -23,15 +23,33 @@ search and `llms.txt`, adopter CI, a dependency-free format checker
|
|
|
23
23
|
operate it. Everything emitted is yours (the templates are MIT-0), the
|
|
24
24
|
scaffold is deterministic and offline, and every refusal explains itself.
|
|
25
25
|
|
|
26
|
-
> **`0.x` status:** `init` works,
|
|
27
|
-
>
|
|
28
|
-
>
|
|
29
|
-
>
|
|
30
|
-
>
|
|
26
|
+
> **`0.x` status:** `init` works, `build` checks the record and writes its
|
|
27
|
+
> lock, `migrate` rewrites a pre-profile record into the profile, and `serve`
|
|
28
|
+
> runs the MCP server over a built record (with `ingest`/`schema`/`calibrate`/
|
|
29
|
+
> `gc` — the climbed rung, needing Postgres and a provider key). Only `dev` is
|
|
30
|
+
> designed, not implemented — it prints an honest notice and exits `2` (inside
|
|
31
|
+
> a scaffolded project, `pnpm dev` covers local work), as does
|
|
32
|
+
> `build --bundles`.
|
|
31
33
|
> [`docs/status.md`](https://github.com/panaversity/ksor/blob/main/docs/status.md)
|
|
32
34
|
> and the released version number are authoritative for the exact released
|
|
33
35
|
> functionality.
|
|
34
36
|
|
|
37
|
+
### What a document can do
|
|
38
|
+
|
|
39
|
+
`knowledge/` is CommonMark, and stays CommonMark — every affordance below is
|
|
40
|
+
syntax that other readers already handle, so a record renders honestly on
|
|
41
|
+
GitHub, in a plain editor, at `/md/` and in `llms-full.txt`.
|
|
42
|
+
|
|
43
|
+
| Write | The site renders |
|
|
44
|
+
| ----- | ---------------- |
|
|
45
|
+
| `> [!WARNING]` as a blockquote's first line | a callout, tinted in that kind's colour |
|
|
46
|
+
| ` ```bash tab="Claude Code" ` on consecutive fences | one tab group, the choice remembered |
|
|
47
|
+
| a fence with no language | a passage to reproduce, set for reading |
|
|
48
|
+
|
|
49
|
+
Nothing to author for the rest: a table's head reads as a head, a numbered list
|
|
50
|
+
counts in the record's accent, and a code block wider than the column gets a
|
|
51
|
+
button that unwraps it.
|
|
52
|
+
|
|
35
53
|
### Study attachments
|
|
36
54
|
|
|
37
55
|
A document may carry companions named after it, and the site renders each on
|
|
@@ -53,8 +71,10 @@ covers the opening and trails off leaves a reader believing they have the whole
|
|
|
53
71
|
document.
|
|
54
72
|
|
|
55
73
|
An attachment is **part of its document**: no URL, no sidebar row, no
|
|
56
|
-
`llms.txt` line, and no id an agent can cite. It takes its
|
|
57
|
-
|
|
74
|
+
`llms.txt` line, and no id an agent can cite. It takes its audience and any
|
|
75
|
+
takedown from its parent, so restricting the document restricts them all. A
|
|
76
|
+
`<doc>.summary.md` carries exactly `type: Summary` and nothing else — a marker,
|
|
77
|
+
never governance of its own.
|
|
58
78
|
A quiz whose answers are guessable is refused by the build, and because ingest
|
|
59
79
|
creates no node for an attachment, a quiz's answer key can never reach the
|
|
60
80
|
agent surface at all.
|
|
@@ -72,7 +92,7 @@ Full concept, design goals, and project status:
|
|
|
72
92
|
|
|
73
93
|
```bash
|
|
74
94
|
npm install -g @panaversity/ksor # command installed: ksor
|
|
75
|
-
npx @panaversity/ksor
|
|
95
|
+
npx @panaversity/ksor@latest # or run without installing
|
|
76
96
|
```
|
|
77
97
|
|
|
78
98
|
## License
|