meyverickmeyverick/agentic/skills/okf-docs/SKILL.md

okf-docs

Skill0 starsChanged 13 days agoISCView on GitHub

Author, audit, and synchronize OKF v0.2 documentation: non-technical Spotlight README.md files, "Easy to Use, Hard to Master" progressive wiki/ directories (orchestrator and per-package submodules), ADRs, and public-only GitHub Wiki provisioning and sync. Use before any push, release, or changelog update, or whenever creating/modifying README.md, wiki/, or ADR artifacts. Do NOT use for pure internal code edits that do not alter behavior, workflows, architecture, or release state.

1 other project uses a version of this.

Adopted by

Most recently taken up by

julienlegoux/skillstheir own version, first seen Aug 8, 2026

Other versions1 project uses a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 1
julienlegoux/skills★ 4same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository18 other files it gives its agents.
- AGENTS.mdAGENTS.md
- apex-performance-auditorSkill
- checkSkill
- context7-mcpSkill
- design-craftSkill
- framework-engine-stacksSkill
- guardrailsSkill
- hypermedia-engine-stacksSkill
- learning-curatorSkill
- pi-lens-ast-grepSkill
- pi-lens-lsp-navigationSkill
- pi-lens-write-ast-grep-ruleSkill
- pi-lens-write-tree-sitter-ruleSkill
- rust-systemsSkill
- scalabilitySkill
- select-modelSkill
- skill-authoring-visionSkill
- systems-auditorSkill

The file

We split this skill into the rules it gives an agent

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Does NOT trigger on: Read-only codebase exploration.
line 20
Very specific:
Must be tracked in Git (git add wiki/) AND structured across 4 progressive mastery tiers so beginners get frictionless onboarding while …
line 31
Very specific:
Never enable or push GitHub Wiki on private or internal repositories (isPrivate != false).
line 53
Very specific:
Never ingest-write into ./references/ — index or inspect, never modify.
line 54

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.

Files

SKILL.md

okf-docs — OKF v0.2 Documentation, Progressive Wiki & Public GitHub Wiki Governance

1. Activation Boundary

Triggers on: Authoring or updating README.md, wiki/, or ./modules/<package>/wiki/; preparing a commit push, release, or CHANGELOG.md entry; auditing docs for OKF v0.2 compliance; provisioning or syncing GitHub Wikis on public repositories.
Does NOT trigger on: Read-only codebase exploration; internal implementation fixes with zero user, operational, or architectural surface change (until pre-push/release gate).

2. The Three Pillars of OKF v0.2 Documentation

Pillar 1 — The Spotlight `README.md` (Universal Human Accessibility)

Written strictly as a clear, inspiring product spotlight that anyone (non-technical users, stakeholders, everyday readers) can immediately understand.
Hard Prohibition: Zero fenced code/terminal blocks (```bash, ```sh, ```rust, etc.), zero CLI flags, zero compiler/architecture jargon, and zero environment variable tables. All technical setup belongs exclusively in wiki/.
Mandatory Closing Section: Names the thanks.dev support link, points readers to CONTRIBUTING.md for how to help and fund, and to root DEPENDENCIES.md (generated with .github/FUNDING.yml by the check skill's scripts/funding-gate.ts). CREDITS.md is reserved for human contributors — never generate it, never list dependencies there.

Pillar 2 — The Progressive `wiki/` ("Easy to Use, Hard to Master")

Maintained at wiki/ for the Tier 1 Root Orchestrator and ./modules/<package>/wiki/ for each domain package repository.
Must be tracked in Git (git add wiki/) AND structured across 4 progressive mastery tiers so beginners get frictionless onboarding while masters get exhaustive internals:
- index.md (mirrored to Home.md on GitHub Wiki): Curriculum map & navigation catalog.
- Tier 1 — Beginner (01-getting-started.md): Plain-language concepts, 5-minute quickstart, first success path.
- Tier 2 — Practitioner (02-guides-and-workflows.md): Everyday usage, configuration recipes, common scenarios.
- Tier 3 — Advanced (03-architecture-and-internals.md): System topology, data contracts, state machines, performance invariants.
- Tier 4 — Master (04-mastery-and-extension.md & adr/): Edge cases, custom extensions, troubleshooting matrices, and Architecture Decision Records (adr/).

Pillar 3 — Public-Only GitHub Wiki Provisioning & Sync

Executed before push/release via bun scripts/sync-wiki.ts <repo-dir>.
Checks repository visibility (gh repo view --json isPrivate).
If Private/Internal (isPrivate == true): Immediately exits 0 without enabling or pushing to GitHub Wiki.
If Public (isPrivate == false): Enables GitHub Wiki (gh repo edit --enable-wiki=true), provisions the remote .wiki.git repository automatically, copies tracked wiki/*.md files (generating Home.md and _Sidebar.md from index.md), and pushes to <repo>.wiki.git.

3. Progressive Reference & Script Routing

Full OKF v0.2 frontmatter schema, Spotlight README.md template, and 4-Tier wiki/ templates -> references/okf.md
Automated public check, wiki enablement, provisioning, and Git sync -> scripts/sync-wiki.ts

4. Hard Rules

Frontmatter okf_version: "0.2" and type are REQUIRED on every wiki/*.md, ADR, and specification document (README.md omits raw YAML frontmatter for clean landing page rendering).
README.md = non-technical spotlight for everyday users — zero technical or terminal code blocks.
Never enable or push GitHub Wiki on private or internal repositories (isPrivate != false).
Never ingest-write into ./references/ — index or inspect, never modify.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

It worked
Partly
It didn't

What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free