doc-mirror-sync
Skill326 starsChanged 8 months agoMITView on GitHub
Automatically synchronizes plugin READMEs to the official documentation directory (docs/). Use after editing a plugin's local documentation to keep the MkDocs site up to date.
1 other project uses a version of this.
Adopted by
Most recently taken up by
- Fu-Jie/awesome-openwebuiword for word, first seen Oct 8, 2026
Other versions1 project uses a version of this.
Word for word · 1
- Fu-Jie/awesome-openwebui★ 326100% same
Edited · 0
None found.
Wrote their own version · 0
None found.
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 repository16 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- community-announcerSkill
- gh-discussion-replierSkill
- gh-issue-replierSkill
- gh-issue-schedulerSkill
- i18n-validatorSkill
- playwright-openwebuiSkill
- plugin-scaffolderSkill
- pr-reviewerSkill
- pr-submitterSkill
- publish-no-version-bumpSkill
- release-finalizerSkill
- release-prepSkill
- source-code-analyzerSkill
- version-bumperSkill
The file
We split this skill into the rules it gives an agent
10 rules. About 0 are common, 5 are distinctive, and 5 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
Distinctive · estimate
This author's own choices. Worth a look.
5
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 12
Use this mode when the request is "only sync docs".
- Very specific: line 14
Only update documentation mirror files under docs/plugins/.
- Distinctive: line 15
Do not bump plugin version.
- Very specific: line 16
Do not modify plugin code (plugins/.py) unless explicitly requested.
- Distinctive: line 17
Do not update root badges/dates for release.
- Distinctive: line 18
Do not run release preparation steps.
- Very specific: line 23
Update version badges in docs/plugins/{type}/index.md.
- Very specific: line 48
If asked for English-only update, sync only README.md -> .md mirror.
- Very specific: line 49
If both languages are requested, sync both README.md and README_CN.md.
- Distinctive: line 50
After syncing, verify git diff only contains docs file changes.
≈ “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.
Files
Doc Mirror Sync
Overview
Automates the mirroring of plugins/{type}/{name}/README.md to docs/plugins/{type}/{name}.md.
Docs-Only Mode (No Release Changes)
Use this mode when the request is "only sync docs".
- Only update documentation mirror files under
docs/plugins/**. - Do not bump plugin version.
- Do not modify plugin code (
plugins/**.py) unless explicitly requested. - Do not update root badges/dates for release.
- Do not run release preparation steps.
Workflow
- Identify changed READMEs.
- Copy content to corresponding mirror paths.
- Update version badges in
docs/plugins/{type}/index.md.
Commands
Sync all mirrors (EN + ZH)
python .github/skills/doc-mirror-sync/scripts/sync.pySync only one plugin (EN only)
cp plugins/<type>/<name>/README.md docs/plugins/<type>/<name>.mdSync only one plugin (EN + ZH)
cp plugins/<type>/<name>/README.md docs/plugins/<type>/<name>.md
cp plugins/<type>/<name>/README_CN.md docs/plugins/<type>/<name>.zh.mdNotes
- If asked for English-only update, sync only
README.md->.mdmirror. - If both languages are requested, sync both
README.mdandREADME_CN.md. - After syncing, verify git diff only contains docs file changes.
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
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.