refactor(okf): split skill spec, rename TEMPLATE to SAMPLE, tighten wiki reliability - #879
Conversation
…to SAMPLE Keeps SKILL.md focused on overview/usage; detailed frontmatter fields, index.md/log.md structure, citations, and versioning now live in SPEC.md, loaded only when needed. TEMPLATE/ renamed to SAMPLE/ since it's a worked example to copy from, not a fill-in-the-blanks template; its internal cross-links now use relative paths, matching the skill's own guidance to deviate from the spec's bundle-absolute link preference.
…to ~/wiki Renames the section for clarity and switches the durable-knowledge bundle path from ~/.okf/ to ~/wiki/, since the directory holds a wiki of knowledge, not just OKF tooling. Skill reference uses the \okf invocation form.
AGENTS.md's Knowledge Wiki section only said "maintain as you go," which left write timing to model discretion. Adds a concrete write trigger with example (mirroring the auto-memory system's approach) and a search-first rule to avoid near-duplicate concepts. opencode had no permission entry for ~/wiki/, so every write would have prompted via its external_directory "ask" default since the path sits outside the project directory. Claude Code's equivalent Edit permission already exists locally; kept out of this template since that file's allow list isn't otherwise tracked in the repo.
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (12)
📝 WalkthroughWalkthroughThe PR defines an OKF specification, updates its sample bundle, and changes agent guidance and permissions to support durable knowledge stored in ChangesOKF knowledge wiki
Estimated code review effort: 3 (Moderate) | ~20 minutes Possibly related PRs
Suggested labels: Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request transitions the Open Knowledge Format (OKF) durable knowledge directory from ~/.okf/ to ~/wiki/, updates permissions in opencode.json, and updates the sample files to use relative links instead of bundle-absolute links. It also refactors SKILL.md by extracting detailed specifications into a new SPEC.md file. The review feedback highlights a typo in AGENTS.md where the okf skill is incorrectly referenced with a backslash as \okf.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
❌MegaLinter analysis: Error
MegaLinter failed because of FAIL_IF_UPDATED_SOURCES=true Notices📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining See detailed reports in MegaLinter artifacts Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining
|
✅
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| ✅ BASH | bash-exec | 3 | 0 | 0 | 0.02s | |
| ✅ BASH | shellcheck | 3 | 0 | 0 | 0.12s | |
| ✅ REPOSITORY | checkov | yes | no | no | 26.35s | |
| ✅ REPOSITORY | devskim | yes | no | no | 2.29s | |
| ✅ REPOSITORY | dustilock | yes | no | no | 0.03s | |
| ✅ REPOSITORY | gitleaks | yes | no | no | 1.87s | |
| ✅ REPOSITORY | grype | yes | no | no | 54.0s | |
| ✅ REPOSITORY | kingfisher | yes | no | no | 9.57s | |
| osv-scanner | yes | 1 | no | 0.16s | ||
| ✅ REPOSITORY | secretlint | yes | no | no | 2.26s | |
| ✅ REPOSITORY | syft | yes | no | no | 2.32s | |
| ✅ REPOSITORY | trivy | yes | no | no | 11.75s | |
| ✅ REPOSITORY | trivy-sbom | yes | no | no | 0.11s | |
| ✅ REPOSITORY | trufflehog | yes | no | no | 5.1s |
Detailed Issues
⚠️ REPOSITORY / osv-scanner - 1 error
Scanning dir .
Starting filesystem walk for root: /
End status: 47 dirs visited, 160 inodes visited, 0 Extract calls, 3.671908ms elapsed, 3.672129ms wall time
No package sources found, --help for usage information.
Notices
📣 MegaLinter 9.5.0 is out! Discover the new features and security recommendations in the release announcement. (Skip this info by defining SECURITY_SUGGESTIONS: false)
See detailed reports in MegaLinter artifacts
Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)
- Documentation: Custom Flavors
- Command:
npx mega-linter-runner@9.5.0 --custom-flavor-setup --custom-flavor-linters BASH_EXEC,BASH_SHELLCHECK,REPOSITORY_CHECKOV,REPOSITORY_DEVSKIM,REPOSITORY_DUSTILOCK,REPOSITORY_GITLEAKS,REPOSITORY_GRYPE,REPOSITORY_OSV_SCANNER,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,REPOSITORY_KINGFISHER
Show us your support by starring ⭐ the repository
|
Caution Failed to replace (edit) comment. This is likely due to insufficient permissions or the comment being deleted. Error details |
1 participant
Summary
okfskill'sSKILL.mdinto a concise overview + steps, with detailed field-level spec pushed toSPEC.md(progressive disclosure)TEMPLATE/toSAMPLE/(it's a worked example to copy from, not a fill-in-the-blanks template) and converts its internal cross-links to relative paths, per the skill's own deviation from the OKF spec's bundle-absolute link preferenceAGENTS.md's Knowledge Wiki section: adds an explicit write trigger with a concrete example (mirroring the auto-memory system's approach) and a search-before-write rule, since "maintain as you go" alone left write timing to model discretion~/wiki/edit + external_directory permission (previously unset, which would prompt on every wiki write since the path sits outside the project directory)Test plan
chezmoi applyrenders bothSKILL.md/SPEC.mdand the updatedAGENTS.md/opencode.jsontemplates without errorsSAMPLE/,SPEC.mdcross-links correctly when invoked~/wiki/edits🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
~/wiki/.Documentation