Skip to content

chore(knowledge): adopt OKF knowledge bundle and bashkit repo conventions - #15

Merged
chaliy merged 1 commit into
mainfrom
claude/project-thread-s7y4cp
Oct 26, 2026
Merged

chaliy merged 1 commit into
mainfrom
claude/project-thread-s7y4cp

Conversation

@chaliy

@chaliy chaliy commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

Requested by Михайло · project thread

What changed

Brings markkit's repo layout and process up to bashkit's current conventions, and runs the first maintenance pass under them.

  • Knowledge bundle: specs/ → knowledge/, an OKF v0.2 bundle grouped into foundations/, formats/, security/, runtimes/, operations/, with frontmatter, per-directory index.md, log.md and a knowledge-contract.md. scripts/check_okf.py (ported from bashkit) plus pinned okf-lint run in just check-okf and the CI lint job.
  • Agent guidance: AGENTS.md rewritten in bashkit style (knowledge map, maintenance invocation contract, pre-PR checklist, commit attribution). New maintain skill; ship/process-issues get skill frontmatter and point at knowledge/. Script test asserts .claude/skills stays a symlink to .agents/skills.
  • CI hardening (workflow credential audit): every workflow has top-level permissions: contents: read; every checkout sets persist-credentials: false except release.yml's tag push.
  • CI coverage: examples now run in CI (just examples); just check/pre-pr include knowledge, script tests and examples. just bench runs the real criterion benches (old stub harness is just bench-harness).
  • Docs corrected against the code: README (badges, format table, Security/Documentation sections, fixed Node snippet that redeclared const markdown), SECURITY.md (no allowlist/memory budget claims that aren't implemented), getting-started (dead specs/00x links), Python package doc (module is markkit, not markkit_python), examples list (the four that exist), eval/bench marked as stubs, T3 SSRF marked open because http_client is a default feature and extract_url has no private-network blocking.
  • cargo update (6 semver bumps), PULL_REQUEST_TEMPLATE from bashkit.

Why

Markkit used the older specs/ layout and lacked bashkit's knowledge contract, maintenance skill and CI audit rules; several docs had drifted from the code.

Before / After

No library behavior change.

$ just check-okf
knowledge: OKF v0.2 conformant (15 concepts, 6 index files, 1 log file)
okf-lint 0.1.1: knowledge conforms to OKF v0.2
$ just pre-pr   # fmt, clippy, test, check-okf, script tests (22), examples, deny
advisories ok, bans ok, licenses ok, sources ok

Maintenance findings going out as separate PRs: unused dependencies + pending major upgrades, and a real bug where indented HTML loses paragraph breaks (<body>\n <h1>A</h1>\n <p>B</p> renders # A\n B).

Risk

  • Low
  • CI now installs okf-lint (about a minute) and runs examples; a broken example fails CI.

Checklist

  • Tests added or updated (scripts/tests/)
  • Backward compatibility considered (docs/process only)

Generated by Claude Code

…ions

Move specs/ to an OKF v0.2 knowledge/ bundle (foundations, formats,
security, runtimes, operations) with frontmatter, indexes, log and a
maintenance contract. Port check_okf.py from bashkit and run it plus
okf-lint in CI and just check-okf.

Rewrite AGENTS.md in bashkit style with a knowledge map and maintenance
invocation contract; add the maintain skill and give all skills
frontmatter. Audit workflows: top-level read-only permissions and no
persisted checkout credentials outside the release tag push. Run
examples in CI. Correct README, SECURITY, getting-started and binding
docs against the code.
@chaliy chaliy self-assigned this Oct 26, 2026
@chaliy
chaliy merged commit 6296654 into main Oct 26, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant