weekly-audit
Skill8.8k starsChanged 36 days agoMITView on GitHub
Whole-repo audit of MiaoYan across five dimensions (stale rules and dead code, performance, broken behaviour, editing experience, preview experience), every finding refuted once before it is reported, then the approved fixes landed. Use for the periodic check or a whole-app review. Not for one reported bug (/hunt), a diff review (/check), or a release's incident review (AGENTS.md Release Notes).
6 other projects use a version of this.
Adopted by
Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data
Most recently taken up by
- HurricaHjz/SecondSelftheir own version, first seen Nov 15, 2026
- HurricaHjz/second-yourselftheir own version, first seen Nov 15, 2026
- matthewzammit/skillstheir own version, first seen Nov 8, 2026
- xpoes123/claude-skillstheir own version, first seen Oct 20, 2026
- tw93/Moletheir own version, first seen Oct 17, 2026
- ianlkl11234s/mini-taiwan-pulsetheir own version, first seen Oct 8, 2026
Who's talking about tw93/MiaoYan
- jaywcjlove/awesome-mac“Update MiaoYan description and add OSS and Freeware icons”GitHub · Nov 11, 2026
- SoloUnity/macos-apps-and-enhancements“Add MiaoYan to Text Editors”GitHub · Nov 11, 2026
- sraodev/awesome-macOS“Add MiaoYan”GitHub · Nov 11, 2026
- gendotnew/macos-apps“Add MiaoYan to Write”GitHub · Nov 11, 2026
- iCHAIT/awesome-macOS“Suggestion: add MiaoYan to Editors”GitHub · Nov 11, 2026
The biggest 5 of 14 mentions linking to the repository that our crawl found. Each line is their own headline.
See all 14
Talked about on GitHub (14 times).
On GitHub · 14
- Nov 11, 2026Update MiaoYan description and add OSS and Freeware icons — jaywcjlove/awesome-mac0 reactions
- Nov 11, 2026Add MiaoYan to Text Editors — SoloUnity/macos-apps-and-enhancements0 reactions
- Nov 11, 2026Add MiaoYan — sraodev/awesome-macOS0 reactions
- Nov 11, 2026Add MiaoYan to Write — gendotnew/macos-apps0 reactions
- Nov 11, 2026Suggestion: add MiaoYan to Editors — iCHAIT/awesome-macOS0 reactions
9 more on GitHub
- Nov 6, 2026Add MiaoYan to UPCOMING.md (Apple Mac OS X) — mundimark/awesome-markdown-editors0 reactions
- Nov 6, 2026Add MiaoYan to applications.json — serhii-londar/open-source-mac-os-apps0 reactions
- Jun 19, 2026miaoyan update error — Homebrew/homebrew-cask0 reactions
- May 5, 2026AI Discovery: 2026-05-05 — liyunhui0707/Markdown-Editor0 reactions · 1 comment
- Apr 14, 2025tw93/MiaoYan: ⛷ Lightweight Markdown app to help you write great sentences. ⛷ 轻灵的 Markdown 笔记本伴你写出妙言 — sing1ee/url-notes0 reactions
- Apr 29, 2024我的年度工具折腾之旅 — guevara/read-it-later0 reactions
- Feb 17, 2024我的年度工具折腾之旅 — guevara/read-it-later0 reactions
- Oct 1, 2022妙言 - 更适合工程师用的 markdown 笔记应用 — SwiftOldDriver/iOS-Weekly0 reactions
- Jun 15, 2022妙言 - 轻灵的 Markdown 笔记本伴你写出妙言 — 521xueweihan/HelloGitHub0 reactions · 1 comment
Other versions6 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 6
- tw93/Mole★ 75ksame name
- ianlkl11234s/mini-taiwan-pulse★ 546same name
- HurricaHjz/second-yourself★ 150same name
- HurricaHjz/SecondSelf★ 150same name
- matthewzammit/skills★ 4same name
- xpoes123/claude-skills★ 0same 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.
The file
We split this skill into the rules it gives an agent
5 rules. 0 are common, 1 is distinctive, and 4 are very specific to this project.
0
Common
Most of the 3 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
4
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 24
Read the newest entry of docs/weekly-audit.md: its "Next window from" commit is this run's window, its "Decided, do not re-report" list …
- Very specific: line 33
Run the mechanical checks first and hand their output to the agents: python3 scripts/check_incidents.py, swiftlint lint --strict, …
- Distinctive: line 41
Read-only until Phase 4. 「看看 / 检查」 never authorizes a write.
- Very specific: line 83
When references/prompts.md or the model changed since the last run, rescore first: for each docs/incidents.md row, run the matching …
- Very specific: line 94
Every behaviour fix carries a test that fails on the old code (red-run it), and a fix for something a user or the daily build met adds its …
“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Weekly Audit
Modelled on Mole Mac's weekly audit (2026-10-16), whose value was the few findings that survived refutation, not the volume. The first MiaoYan run was on 2026-11-05, after V4.7.0. Run it after each release, or weekly while work is heavy.
Phase 1: Freeze and scope
- Read the newest entry of
docs/weekly-audit.md: its "Next window from" commit is this run's window, its "Decided, do not re-report" list goes to every agent, and its "Open" items are rechecked first. - Record
git rev-parse HEAD,origin/main,git status --shortandgit log --oneline <window>..HEAD. - Exclude
.claude/worktrees/,build/,.build/and the vendored files inResources/DownView.bundle(every*.min.jsand*.min.css,js/vendor/,js/mermaid-layout-elk*.js,ppt/) from every grep and read; the bundle's own code isindex.html,ppt.html, the otherjs/*.jsandcss/*.css. - Run the mechanical checks first and hand their output to the agents:
python3 scripts/check_incidents.py,swiftlint lint --strict,swift-format lint --recursive . --strict. - Scope: the whole tree on the first run, after a release, or when the window
touched more than about 40 source files; otherwise the window's files, their
direct callers and every Open item. The iPhone and iPad app lives in the private
MiaoYan-Pro checkout (
MiaoYanMobile/); include it when that checkout sits beside this one, read-only, and never quote its code or paths in this public repository. - Read-only until Phase 4. 「看看 / 检查」 never authorizes a write.
Phase 2: Five read-only audits in parallel
One Agent per dimension, model: "opus", read-only (no edit, build or test),
each started from the shared header plus its body in references/prompts.md, so
coverage does not drift between runs. Each tries to refute every candidate once
(the guard that already blocks it, the test that locks it, the AGENTS.md line
recording the decision) and reports only survivors with file:line, a concrete
failure scenario and the smallest fix.
- Stale. Current-state claims in AGENTS.md, ARCHITECTURE.md,
.claude/rules,docs/,skills/miaoyanand README against the code; zero-caller symbols, dead CSS and JS, forward-only wrappers, duplicated helpers, comments naming removed functions. AGENTS.md deliberately records rejected designs; a missing symbol there is usually a correct record. - Performance. Main-thread file IO and synchronous reads, per-keystroke work in the editor (highlighting, regex compiles, full-storage scans), per-row work in the note list and sidebar, preview updates that reload instead of patching, unbounded caches, launch work, file-watcher storms.
- Behaviour. Defects that lose or misplace user data or make a feature not
work: the Current Risk Areas in AGENTS.md (buffer ownership, Trash, iCloud,
symlinks, folder moves,
loadFailed), menu and shortcut parity between the storyboard window and the shell, localisation gaps. - Editing. What a writer feels: input latency, CJK input and marked text, undo grouping, cursor and scroll jumps on save, reload or highlight, auto-pair and list continuation, paste, formatting commands, find, focus after actions.
- Preview. What a reader feels: flashes, scroll jumps on edit or note switch, images and media reserving space, code, math, Mermaid, tables, TOC, split-view sync, PPT, and PDF / PNG / HTML export fidelity in light and dark.
Phase 3: Report
One merged report ranked by risk: behaviour, editing, preview, performance, stale. Each row: what, where, evidence, smallest fix, and whether it needs the maintainer (user-visible behaviour, a recorded decision, release timing). Before reporting, verify the weakest high-severity claim yourself and grep AGENTS.md for every candidate's symbol: a decision or measurement may live in another section. End with what was checked and found fine, and the questions only the maintainer can answer. Rendered-only defects (alignment, flashes, motion) are listed for a real-app check rather than asserted from reading.
When references/prompts.md or the model changed since the last run, rescore
first: for each docs/incidents.md row, run the matching dimension's prompt on
the files the fix touched as they were at <Fixed>^, and record how many rows it
found.
Phase 4: Land what the maintainer approves
- Fix agents work in detached worktrees under the scratchpad
(
git worktree add --detach <scratch>/wt-<n> origin/main), commit locally without pushing, and never share a file. Start each from the fix header inreferences/prompts.md. - Every behaviour fix carries a test that fails on the old code (red-run it), and
a fix for something a user or the daily build met adds its
docs/incidents.mdrow in the same commit. - Agent reports are leads: check every "unused", "dead" or "already broken" claim yourself, read each agent's deviations, and close its "not done" list.
- Stack the commits on current
origin/main, run the fullxcodebuild test,swift test --package-path Packages/MiaoYanCore, SwiftLint and swift-format, plus the extra gatesscripts/risk_tier.pynames for the touched paths, then push. UI fixes go through AGENTS.md Verification (the built app replaces/Applications/MiaoYan.app). - Append the run to
docs/weekly-audit.md(audited and landed commits, next window, fixed / decided / open) in the last commit of the run.
Known traps
xcodebuild testhangs while/Applications/MiaoYan.appruns unless the command addsPRODUCT_BUNDLE_IDENTIFIER=com.tw93.miaoyan.qa.- CI builds with Xcode 16.3, whose concurrency checks are stricter than local;
read the run with
gh run viewafter pushing. - A new source or test file needs the four
project.pbxprojregistrations (AGENTS.md Commands). - Two builds sharing the
com.tw93.miaoyan.qabundle id share thewkPreviewcopy ofDownView.bundle; clear it when switching.
Output
The report, then after landing: commits, push status, worktree leftovers, each
finding's state (fixed and verified / decided not to fix with reason / blocked
and what is missing), and the next window, all also written to
docs/weekly-audit.md.
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.

