Przejdź do treści
Biblioteka skilli
Programowanie · Przegląd i audyt

docs-review

/docs-review

Ocenia strony dokumentacji według zestawu reguł docs-quality w dowolnym katalogu i formacie, takim jak Markdown, MDX, reStructuredText, MyST i AsciiDoc, oraz ręcznie uruchamia bramkę dokumentacji.

Repozytorium
grimoire ↗
Licencja
Apache-2.0
Ostatnia zmiana repozytorium
23.10.2026

Ocena i bezpieczeństwo

100/ 100Klasa: dobry
Format25 / 25
Frontmatter z nazwą i opisem, poprawna nazwa, opis do 1024 znaków, nazwa zgodna z folderem.
Odkrywalność25 / 25
Opis mówi, kiedy użyć skilla, ma sensowną długość i jest w 3. osobie.
Treść35 / 35
Co najmniej 150 słów i do 500 linii, nagłówki, listy kroków, przykłady albo kod.
Higiena15 / 15
Bez zaślepek typu TODO, bez ścieżek Windows, z licencją.
Ryzykobrak sygnałów w skanie
Pliki w paczce
1
Skrypty
0
Komentarze HTML
0
Adresy URL w SKILL.md
0
Przestarzałość

Brak sygnałów. Repozytorium zmienione 23.10.2026, bez odwołań do wycofanych modeli i API.

Licencja

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

Co robi i kiedy

Ocenia strony dokumentacji według zestawu reguł docs-quality w dowolnym katalogu i formacie, takim jak Markdown, MDX, reStructuredText, MyST i AsciiDoc, oraz ręcznie uruchamia bramkę dokumentacji.

Oryginalny opis (EN)

Grade documentation pages against the docs-quality rule set on demand, in any directory and any markup format (Markdown, MDX, reStructuredText, MyST, AsciiDoc). Use when someone asks to review, check, grade, lint or audit a doc page, a README, a changelog, a docs directory or the docs changed on a branch, asks whether a page meets docs-quality, or wants the docs gate run by hand. Not for deciding which pages to write, which is docs-plan, and not for wiring the checks into CI, which is docs-instrument.

Jak działa

  1. Stop condition
  2. 1. Pick the targets
  3. 2. Load the rule
  4. 3. Run the checks by format
  5. 4. Report
Sekcje z nagłówków SKILL.md, w oryginale · 69 linii, 416 słów
Podgląd SKILL.md
---
name: docs-review
description: Grade documentation pages against the docs-quality rule set on demand, in any directory and any markup format (Markdown, MDX, reStructuredText, MyST, AsciiDoc). Use when someone asks to review, check, grade, lint or audit a doc page, a README, a changelog, a docs directory or the docs changed on a branch, asks whether a page meets docs-quality, or wants the docs gate run by hand. Not for deciding which pages to write, which is docs-plan, and not for wiring the checks into CI, which is docs-instrument.
license: Apache-2.0
metadata:
  summary: Runs the docs-quality gate by hand over named pages or a branch diff, in any directory and any markup format
  keywords: docs,documentation,review,docs-review,check,lint,audit,grade,readme,changelog,markdown,mdx,restructuredtext,rst,myst,asciidoc,adoc,sphinx,antora,doc_type,docs-quality
---

# docs-review

The `docs-quality` rule loads when an agent edits a page. This skill is the
explicit trigger: grade pages nobody is editing, pages in unusual places, and
pages in a format the scripts only partly read.

## Stop condition

Stop when every target page has a verdict: each finding as
`path:line: DOC-XXX-nn: message`, or `clean`. Mark any finding no script
produced `unverified: reading heuristic`. Report; never fix unless asked.

## 1. Pick the targets

- Named paths or directories: use them as given, whatever their location.
- Nothing named: the branch diff,
  `git diff --name-only --diff-filter=d "$(git merge-base HEAD origin/HEAD)" -- '*.md' '*.mdx' '*.rst' '*.adoc' '*.asciidoc'`.
- Drop agent config (`CLAUDE.md`, `AGENTS.md`, `SKILL.md`, `.claude/`,
  `.agents/`), vendored copies and build output. The rule excludes them too.

## 2. Load the rule

Read the installed `docs-quality` rule index, then only the depth files its
routing table names for the target page types. Find it with
`find . -path '*docs-quality*' -name 'docs-quality.md' -not -path '*/node_modules/*'`.
Its `checks/` directory sits beside it. No hit means the rule is not
installed: say `grim add ghcr.io/ocx-sh/lore/docs-quality` and stop.

## 3. Run the checks by format

`CHECKS` below is that `checks/` directory. Every script takes explicit paths,
so pass the targets rather than `--root`.

| Format | Scripted | Read by hand |
|---|---|---|
| `.md`, `.mdx` | the whole gate, in the rule's order | rows the scripts mark heuristic |
| `.rst`, MyST, `.adoc` | `doc_declaration.py` | everything else, or convert first |

Markdown and MDX:

```bash
python3 "$CHECKS/doc_declaration.py" PAGE...
python3 "$CHECKS/prose.py"           PAGE...
python3 "$CHECKS/page_type.py"       PAGE...
python3 "$CHECKS/landing_check.py"   PAGE...
```

Add `doc_examples.py`, `nav_depth.py` and `links_raw.py` when the review covers
a whole docs tree rather than single pages. Their inputs are a tree.

reStructuredText and AsciiDoc: run `doc_declaration.py` on the source. The
prose and page-type scripts parse Markdown only. When `pandoc` is on the PATH,
convert each page into a scratch directory and run them on the copy:

```bash
pandoc -f rst -t gfm PAGE.rst -o "$SCRATCH/PAGE.md"   # asciidoc: asciidoctor -b docbook | pandoc -f docbook
```

Line numbers from a converted copy point at the copy. Map each finding back to
the source line by its quoted text before reporting it. No converter means the
non-negotiables are read by hand and every such finding is marked unverified.

## 4. Report

One line per finding, grouped by page, ordered by the rule's non-negotiable
number. End with a count per page. Undeclared pages are listed first, because
every type-scoped check skipped them.

Wersje

RepozytoriumWynikLicencja
Ta strona · grimoire-rs/grimoire100Apache-2.0
swarm-routing/skills100LGPL
nexus-substrate/nexus-agents100MIT
mickeyyaya/evolve-loop100Apache-2.0
metabase/metabase100AGPL-3.0
mintlify/docs100MIT
SVN11X/skills100MIT
getsentry/sentry-docs100Apache-2.0
omexit/claude-skills-pack100MIT

Identyczna treść występuje jeszcze w 1 innych folderach na GitHubie. Tu pokazujemy jedną, najlepiej ocenioną kopię.

Migawka bazy z 13.11.2026 · wersja paczki 7cf0c150c213 (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

  • 98rst-to-myst
    Zamienia strony dokumentacji Ray z formatu reStructuredText na MyST Markdown, zachowując odnośniki i dyrektywy.
  • 100docs
    Pomaga edytować dokumentację projektu w katalogu Doc/: format reStructuredText, znaczniki versionadded i versionchanged, wpisy NEWS, What's New oraz budowanie HTML.
  • 96docs
    Aktualizuje dokumentację Konstruct w Sphinx i MyST oraz README, gdy zmienia się polecenie, opcja, wynik albo liczba.
  • 100writing-docs
    Podpowiada, jak pisać i edytować dokumentację Remotion, w tym strony MDX w pakiecie docs.
  • 100markdown-structured
    Obsługuje wczytywanie znaczników strukturalnych do RAG: markdown, AsciiDoc, reStructuredText, frontmatter, metadane hierarchii nagłówków, dzielenie z poszanowaniem bloków kodu, tabele, linki wewnętrzne, vaulty Obsidian i Dendron oraz MDX.
  • 100technical-docs
    Pisze i recenzuje dokumentację techniczną SDK Sentry, zwłaszcza pliki MDX w docs/platforms.

Uwagi i zgłoszenia

Wiadomość trafi do Bartosza Sokolińskiego. Adres e-mail jest potrzebny tylko do odpowiedzi. Szczegóły w polityce prywatności.