Repository navigation
chore(knowledge): adopt OKF knowledge bundle and bashkit repo conventions - #15
Merged
Merged
Conversation
…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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.
specs/→knowledge/, an OKF v0.2 bundle grouped intofoundations/,formats/,security/,runtimes/,operations/, with frontmatter, per-directoryindex.md,log.mdand aknowledge-contract.md.scripts/check_okf.py(ported from bashkit) plus pinnedokf-lintrun injust check-okfand the CI lint job.AGENTS.mdrewritten in bashkit style (knowledge map, maintenance invocation contract, pre-PR checklist, commit attribution). Newmaintainskill;ship/process-issuesget skill frontmatter and point atknowledge/. Script test asserts.claude/skillsstays a symlink to.agents/skills.permissions: contents: read; every checkout setspersist-credentials: falseexceptrelease.yml's tag push.just examples);just check/pre-princlude knowledge, script tests and examples.just benchruns the real criterion benches (old stub harness isjust bench-harness).const markdown), SECURITY.md (no allowlist/memory budget claims that aren't implemented), getting-started (deadspecs/00xlinks), Python package doc (module ismarkkit, notmarkkit_python), examples list (the four that exist), eval/bench marked as stubs, T3 SSRF marked open becausehttp_clientis a default feature andextract_urlhas no private-network blocking.cargo update(6 semver bumps),PULL_REQUEST_TEMPLATEfrom 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.
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
okf-lint(about a minute) and runs examples; a broken example fails CI.Checklist
scripts/tests/)Generated by Claude Code