Oma Docs

OrganizationPopular

first-fluke

oma-docs

Check documentation references, sync docs to code changes, and detect translation drift. Use for documentation maintenance in a repository.

Overview

Publisher	first-fluke
Repository	`oh-my-agent`
Skill name	`oma-docs`
Stars	1.3K
Forks	149
Bundled files	1
License	MIT
Links	Skill source Repository Homepage

Markdown instructions
A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.
Works with any LLM
AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.
1 bundled files
Scripts, templates, and references the model can read while it works. Files are read-only and never executed.
Open source
Published by first-fluke on GitHub. Read the source before you install it.

Installation

Install the Oma Docs AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

Open the app and go to Plugins → Skills.
Choose "Install from GitHub".
Paste the skill folder URL below and confirm.
Enable the skill in any chat where you want it available.

Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills

git clone --depth 1 https://github.com/first-fluke/oh-my-agent.git /tmp/oh-my-agent
mkdir -p .claude/skills
cp -r /tmp/oh-my-agent/skills/oma-docs .claude/skills/oma-docs

Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Oma Docs in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Oma Docs on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Oma Docs is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

Loaded only when it is needed
The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.
Switch models mid-chat
Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Documentation Maintenance

Scheduling

Goal

Keep documentation aligned with repository behavior and report verification limits.

Intent signature

Check references, update docs for a code diff, identify translation drift, or lint localized prose.

When to use

Repository documentation verification, diff-based synchronization, and translation maintenance.

When NOT to use

General source research -> oma-search.
Application implementation -> the owning specialist.
Translating known text -> oma-translation.

Expected inputs

Mode (verify, sync, i18n, or lint), target paths or diff range, and authorized edit scope. Use verify when no mode is specified.

Expected outputs

Findings with paths and evidence, authorized patches when requested, and unresolved checks. CLI reports remain distinct from host-authored interpretation.

Dependencies

The oma docs CLI, Git for diff-based work, and repository docs. lychee is optional for URL verification. Read resources/commands.md for flags and output files of the selected mode.

Structural Flow

Transitions

verify: extract and resolve references, then summarize the report.
sync: obtain candidates, read relevant docs and diffs, and apply only authorized corrections.
i18n / lint: report drift or style issues; use oma-translation for authorized corrections.
Review-only requests produce proposals. Existing scoped edit requests authorize applying those corrections without another per-file approval.

Failure and recovery

Failure	Recovery
Missing CLI	State up front that the automated check is unavailable, then inspect manually anyway: list the target markdown files, extract `[text](path)`, `![alt](path)`, and `href`/`src` targets, resolve each relative to its containing file, and report which resolved paths are missing. Skip http(s) URLs and note them as unverified scope. Label the result "manual inspection — `oma docs verify` did not run"; never present it as CLI output and never make installing the CLI a prerequisite
Missing lychee or incomplete URL scan	Report core results and the unverified URL scope
One document cannot be parsed	Record the skipped file and continue other documents
Patch does not apply	Re-read the affected current content and make the equivalent authorized correction
Index write fails	Report the failure; do not claim the index or check is complete

Exit

Report verified findings, edits made, and remaining gaps. A clean reference scan does not establish semantic correctness or complete translation quality.

Logical Operations

Canonical command path

Select mode, paths/diff, and authorization from the request. Read only the matching section of resources/commands.md.
Run oma docs verify --json, oma docs sync <range> --json, oma docs i18n --json, or oma docs lint --json as appropriate. For sync, use the requested range; otherwise staged changes, then HEAD~1..HEAD.
Inspect the structured results. Verify each proposed correction against current code and document context. Exclude secret-bearing files and values from patches and reports.
Apply corrections already authorized by the user or assigned task. Ask only about material missing decisions or new scope; continue independent work while waiting.
Re-run affected checks after edits and record remaining failures. Regenerate the reference index once after a patch batch when needed.

Resource scope and effects

Verification regenerates docs/generated/doc-refs.json; optional URL results go to docs/generated/url-drift.json. Sync's CLI emits candidate data; the host drafts and applies patches. i18n/lint commands report only. A workflow hook runs only when docs.auto_verify is enabled and is warn-only.

Guardrails

Follow ../_shared/core/execution-policy.md for authorization and completion.
Keep review-only requests read-only and changes within the assigned diff or acceptance criteria.
Do not expose secret-bearing files (.env*, private keys, credentials) in diff reports.
The CLI produces structured data; the host performs natural-language synthesis. Do not invent CLI findings or call a vendor LLM API from the docs CLI.
Honor ignore blocks, oma-docs: skip, and configured exclusions. Missing gitignored runtime outputs are skipped, not broken references.
Preserve language, terminology, and placeholders when applying localized corrections.

References

Mode commands, flags, and outputs: resources/commands.md (selected operation only).
Translation: ../oma-translation/SKILL.md (localized correction).
Authorization: ../_shared/core/execution-policy.md (when not already provided).

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

resources/commands.md3 KB

Frequently asked questions

What does the Oma Docs AI skill do?

Check documentation references, sync docs to code changes, and detect translation drift. Use for documentation maintenance in a repository.

Why use Oma Docs on TypingMind?

Because you install it once and use it with any model. Oma Docs is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Oma Docs in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/first-fluke/oh-my-agent/tree/main/skills/oma-docs. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Oma Docs?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Oma Docs?

As many as you like. As long as a model supports skills, you can use Oma Docs with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Oma Docs AI skill free?

Yes. It is published on GitHub by first-fluke under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

View all

Create Agent

microsoft

OrganizationPopular

Create a custom agent (.agent.md) for a specific job.

Create Hook

Create a hook (.json) to enforce policy or automate agent lifecycle events.

Generate Run Commands

microsoft

OrganizationPopular

Generate or modify run commands for the current session. Use when the user wants to set up or update run commands that appear in the session's Run button.

Algorithmic Art

Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or…

Overview

Installation

Install in TypingMind

Install in another agent

Use it in TypingMind

Works with any AI model

Skill instructions

Documentation Maintenance

Scheduling

Goal

Intent signature

When to use

When NOT to use

Expected inputs

Expected outputs

Dependencies

Structural Flow

Transitions

Failure and recovery

Exit

Logical Operations

Canonical command path

Resource scope and effects

Guardrails

References

Bundled files

Frequently asked questions

Related AI Skills

Set up your own AI workspace now