grovefs-docs
/grovefs-docs
Pilnuje, by dokumentacja GroveFS opisywała tylko bieżącą wersję i zgadzała się z grovefs --help, bez historii zmian.
- Autor
- TechWander ↗
- Repozytorium
- GroveFS ↗
- Licencja
- Apache-2.0
- Ostatnia zmiana repozytorium
- 13.11.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 3
- Skrypty
- 2
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 13.11.2026, bez odwołań do wycofanych modeli i API.
Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.
- 2 skrypty w paczce. Przejrzyj je przed instalacją, bo Claude może je uruchomić.
Skrypty: scripts/doccheck.sh, scripts/wikicheck.sh
Co robi i kiedy
Pilnuje, by dokumentacja GroveFS opisywała tylko bieżącą wersję i zgadzała się z grovefs --help, bez historii zmian.
Wyzwalacze z opisu
Oryginalny opis (EN)
Keeps GroveFS documentation (README.md, README.en.md, USAGE.md, docs.html) stating only current-version behavior — no migration history, no removed flags/env vars, no before/after baselines, no "newly added / now supports / identical to the old / falls back to old behavior" change narration. Use when editing, rewriting, or reviewing these files, when auditing whether docs match `grovefs --help`, or when asked to "按最新版本写文档" / "排查文档里的历史叙述" / "参数对账".
Jak działa
- 禁止写进文档
- 必须保留(别误删)
- 工作流程
- Repo Wiki(.qoder/repowiki/)同步
- 硬边界
Podgląd SKILL.md
--- name: grovefs-docs description: Keeps GroveFS documentation (README.md, README.en.md, USAGE.md, docs.html) stating only current-version behavior — no migration history, no removed flags/env vars, no before/after baselines, no "newly added / now supports / identical to the old / falls back to old behavior" change narration. Use when editing, rewriting, or reviewing these files, when auditing whether docs match `grovefs --help`, or when asked to "按最新版本写文档" / "排查文档里的历史叙述" / "参数对账". --- # GroveFS 文档口径(只写当前版本) 四份文档同一规矩:**手册只陈述当前版本的行为,演变史归 git 提交记录。** - `README.md` — 中文简介 + 「诚实标注的边界」清单(中文末段) - `README.en.md` — 英文简介(`README.md` 的对译,口径段在末段) - `USAGE.md` — 使用说明,§14.4 末尾写有口径原文 - `docs.html` — 单文件手册,§21 末尾写有口径原文(两条 `.ok` div) 口径原文本身在每份文档里各写了一次(README 中英两份都要改),改口径要**各处同步**。 ## 禁止写进文档 1. **已移除的参数 / 环境变量 / 开关名**——连「`--strict-view` 与 `GROVEFS_ALLOW_LAZY_VIEW` 已从代码中移除」这种提法也不行:提及名字等于给旧行为招魂,读者会去搜、去试。 2. **版本前后对比**——「改造前基线 55.34s」「从 55s 降到 2.5s」「N=1 行为与旧版完全一致」「无账本行的历史库退回单视图旧行为」。要表达性能,只写**当前实测值 + 测量条件**。 3. **变更动词**——新增了 / 现已 / 已落地 / 已覆盖 / 现已支持 / gained / now also / fall back to the old。改成陈述句:「X 覆盖 Y」「X 是 Z 的唯一路径」。 4. **一次性迁移指引**——升级后要重挂 / 重铸 key 之类的临时动作。写成当前版本的要求(「定义替换 ≤2s 热生效」),不写「以前要怎么改」。 ## 必须保留(别误删) - **当前版本内的真实回退语义**:跨设备 import 退化为独立拷贝、对接不含该能力位的老服务端时退回全量列表、跨节点 link 拒绝并给出原因。这是行为契约,不是历史。 - **「未实现(诚实标注)」负空间清单**:`--subpath`/`--prefix` 等明确说没有的能力,是文档职责。 - **真实程序输出引文**(`no longer resolves`、demo 目录名 `/data/legacy`)、**运维回滚动作**(出问题换回原二进制)。 - 无实测数字处不做收益声称;有限制处在「诚实标注」章节明示。 ## 工作流程 1. 先扫再改,不要凭印象。按这四族关键词分别定位(终端在 CJK 换行处会插假空格,**别把显示出来的空格抄进锚点**): ```bash cd grovefs && grep -nE '已从代码|已移除|不再提供|strict-view|ALLOW_LAZY_VIEW' README.md README.en.md USAGE.md docs.html grep -nE '改造前|旧版|旧行为|退回旧|与旧.*一致' README.md README.en.md USAGE.md docs.html grep -nE '新增了|新增的|现已|已落地|已经落地|now also|gained' README.md README.en.md USAGE.md docs.html grep -nE '[0-9]+(\.[0-9]+)?s? *(→|->|降到)|基线' README.md README.en.md USAGE.md docs.html # 历史基线数字 ``` 2. 改前先核实语义,别用印象填空。行为表述以源码为准(例:空账本的含义查 `src/meta.rs` 模块注释,分页能力查 `MetaProvider::supports_paged_readdir()`)。 3. 分批 SearchReplace,**每批后读 diff**——上一轮的遗漏通常藏在 diff 的上下文行里(`<summary>`、小节标题、英文段落最常漏)。 4. 跑收口检查: ```bash bash skills/grovefs-docs/scripts/doccheck.sh ``` 四项:变更史扫描、参数对账(文档 `--xxx` ↔ `grovefs --help` 真实参数差集)、docs.html 标签闭合、新增用字校验(抓自己打错的汉字)。退出码 0 才算收工。 ## Repo Wiki(`.qoder/repowiki/`)同步 上面三份文档在仓库内、随代码走;Qoder 的 Repo Wiki 是 IDE 另生成的一棵中文站(正文 `.qoder/repowiki/zh/content/**.md`),**不在 git 仓库里**(仓库根是 `grovefs/`,Wiki 落在其上一级 `.qoder/`)。 - **别指望 IDE 自动更新它。** 提交驱动的增量重绑「打开的工作区文件夹」:本工作区根 `/data/grovefs` 不是 git 仓库,IDE 据此把 Wiki 归到魔术分支 `Q0DeR-MaG1C-BrAnCh-Fo2-NoN-GiT-Or-No-C0MmIt`(非 git / 无提交),元数据基线 `last_commit_id` 恒为全零、增量任务表 0 行 —— 自动重扫从未武装。真要让自动更新生效:① 把 `grovefs/`(含 `.git` 那层)作为工作区打开;或 ② 在 IDE Wiki 面板手动「重新生成」以重置基线。二者都是 IDE 侧动作,改代码不触发。 - **过渡期用检查器收口**(像 doccheck 之于三份文档): ```bash bash skills/grovefs-docs/scripts/wikicheck.sh # 退出码 0 = wiki 与代码事实一致 ``` 它拿代码 `--help` 真值对账 Wiki:§2a 数据面每个 `mount`/`data-server` 长选项必须在 Wiki 有提及(新旋钮没同步即失败,自维护);§3 命中写死 stripe 尺寸 / 旧握手 `val=0` 等失效口径;§3b 核心页须体现统一布局键与 `member-id`。§2b 幽灵参数与 §1 自动更新诊断均信息项、不纳入退出码(Wiki 是生成散文,锚点/负空间句假阳性多)。新增特性时顺手往 §3 的 `RXS/WHYS` 补一条旧口径模式。 ## 硬边界 - 只改文字与格式,**不改行为描述的事实**。拿不准某句是不是当前行为,去读源码或跑命令,不要靠猜补全。 - 不为「读起来顺」删掉限制、拒因、单位、测量条件。 - 不新增实测以外的数字,不给没跑过的命令贴「真实回显」。
Pliki w paczce (3)
- SKILL.md 6 KB
- scripts/doccheck.sh 9 KB
- scripts/wikicheck.sh 8 KB
Wersje
W bazie nie ma innych skilli o nazwie grovefs-docs.
Migawka bazy z 13.11.2026 · wersja paczki 8df71f1a288c (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100grovefs-mcp
Zarządza widokami GroveFS przez serwer MCP grovefs mcp: tworzy widoki pochodne, aliasy, forki i reguły układu danych. - 100docs-honesty
Pilnuje, by dokumentacja, README i instrukcje instalacji zgadzały się z wydaniem, bez martwych linków, złych wersji i zmyślonych przykładów wyjścia. - 100readme-generator-free
Generuje README, dokumentację instalacji i użycia oraz odznaki dla projektu na podstawie istniejącego kodu. - 100setup-install-usage-docs
Tworzy lub odświeża docs/INSTALL.md i docs/USAGE.md na podstawie dowodów z repozytorium, gdy dokumentacja jest brakująca lub nieaktualna. - 100trove-docs-sync-audit
Sprawdza, czy dokumentacja nie rozjechała się z kodem: pliki README, przewodniki, zmienne środowiskowe i changelogi, tylko do odczytu. - 100docs
Synchronizuje dokumentację z kodem: aktualizuje README, pliki agentów, docs, changelog i ADR po zmianach, a w trybie kontrolnym tylko zgłasza rozbieżności.