Przejdź do treści
Biblioteka skilli
Programowanie · Pisanie

docs-pr-subsection

/docs-pr-subsection

Zamienia pull request z GitHuba w jedną podsekcję dopisaną do strony, która już opisuje dany obszar, bez nowej strony i zmian w sidebarze.

Autor
zio ↗
Repozytorium
zio-skills ↗
Licencja
Apache-2.0
Ostatnia zmiana repozytorium
27.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 27.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

Zamienia pull request z GitHuba w jedną podsekcję dopisaną do strony, która już opisuje dany obszar, bez nowej strony i zmian w sidebarze.

Argumenty

/docs-pr-subsection <PR number>
Oryginalny opis (EN)

Turn a GitHub pull request into one subsection appended to a page that already documents the area it touches — no new page, no sidebar edit. Use for a PR that only enhances or fixes something already documented, or when the docs-document-pr skill names this as the subsection case.

Jak działa

  1. What you do
  2. When to stop without writing anything
  3. What you are not
  4. Reporting
Sekcje z nagłówków SKILL.md, w oryginale · 90 linii, 658 słów
Podgląd SKILL.md
---
name: docs-pr-subsection
description: >
  Turn a GitHub pull request into one subsection appended to a page that already
  documents the area it touches — no new page, no sidebar edit. Use for a PR
  that only enhances or fixes something already documented, or when the
  docs-document-pr skill names this as the subsection case.
argument-hint: "<PR number>"
allowed-tools: Read, Edit, Grep, Bash(gh:*), Bash(sbt:*), Bash(git:*)
---

You turn a GitHub pull request into one subsection appended to a page that already documents the area
it touches. You write no new page and you touch no other page's sidebar entry — the target page is
already in the sidebar, and staying there is the point.

This is the small half of "document this PR." The other half — a PR introducing a genuinely new
module, type, or feature, with nothing existing to extend — is a full new page: use the
`docs-document-pr` skill instead. Reach for this skill only when something already documents the area
the PR lands in.

## What you do

1. **Fetch the PR.** `gh` infers the repo from the checkout, no `--repo` needed:

   ```bash
   gh pr view <N> --json title,body,state,labels,commits,closingIssuesReferences | head -c 6000
   ```

   For every issue in `closingIssuesReferences`, and any additional issue number the body mentions via
   "closes/fixes/resolves/relates to/see #" that the JSON field missed:

   ```bash
   gh issue view <N> --json title,body,labels | head -c 6000
   ```

   The PR title becomes your subsection's context, the body and linked issues give you the motivation,
   the commit list gives you what actually changed, and the labels are a tiebreaker in the next step.

2. **Confirm this belongs on an existing page.** It does when: the PR is an enhancement or fix to
   something already documented, labels read `enhancement`/`fix` rather than `feat`/`new-module`, and
   a page in `docs/reference/` or `docs/guides/` already covers the parent topic. Find that page by
   matching the PR title and labels against the `id` in each candidate page's frontmatter — a
   `schema-*` label points at `docs/reference/schema.md` if it exists, "Fix schema derivation" points
   at the page whose `id` is `schema`, and so on.

   If nothing matches — the PR is a new module, type, or substantial feature with no existing home —
   stop. Say so, and name `docs-document-pr` as the right skill for it.

3. **Write the subsection**, appended near the end of the target page (after its last `##` section,
   before a trailing "Running the Examples" section if the page has one):

   ```markdown
   ## <Feature Name>

   <One or two sentences of context, drawn from the linked issue's motivation — what problem this
   solves, not a changelog restatement of the commit list.>

   ### Changes in this PR

   - <what changed, one bullet per material change>

   ### Example

   <a prose sentence ending in `:`, then a runnable `mdoc:compile-only` block demonstrating the change>

   ### API Reference

   <new types or methods, if any — link to their reference page with a relative path if one exists>
   ```

   Drop "API Reference" entirely when the PR added no new public surface. Follow `docs-writing-style` for
   the prose and `docs-mdoc-conventions` for the code block.

4. **Insert it.** Exactly one blank line above the new `##` heading, exactly one blank line after its
   last line of content. Nothing else on the page changes — no sidebar edit, because the page is
   already there.

5. **Verify.** `sbt "docs/mdoc --in <path> --out website/<path>"` — never bare `sbt docs/mdoc`. Zero
   `[error]` lines.

6. **Commit.** `docs(<doc-stem>): document PR #<n> — <short feature name>`.

## When to stop without writing anything

- **The request names no PR number.** Ask, and stop.
- **No existing page covers the PR's area.** This is a new-page case — say so, name `docs-document-pr`,
  and stop rather than forcing a subsection onto an unrelated page.
- **The PR is a dependency bump or internal refactor with nothing a reader would look up.** Say so and
  stop; not every merged PR earns documentation.

## What you are not

You do not rewrite the rest of the target page, fix unrelated issues you notice on the way (note them
in your report instead), or touch `sidebars.js` — that file is for pages, and this PR did not add one.

## Reporting

PR title, linked issues found, the target page, the subsection heading you wrote, and whether mdoc
compiled clean. If you stopped instead of writing, say which condition applied.

Wersje

W bazie nie ma innych skilli o nazwie docs-pr-subsection.

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

  • 100docs-document-pr
    Na podstawie numeru pull requesta rozstrzyga, czy potrzebna jest nowa strona dokumentacji, podsekcja istniejącej, czy nic, i wskazuje właściwy skill, sam niczego nie pisząc.
  • 100pr-map
    Zamienia pull request z GitHuba w interaktywną mapę przeglądu z uwagami AI, oglądaną w przeglądarce.
  • 100docs-edit
    Edytuje stronę dokumentacji z otwartym pull requestem lub poprawia ją w miejscu: używa gałęzi PR, czyta rzeczywisty diff, sprawdza powiązane strony i weryfikuje zmiany przed przekazaniem.
  • 90digest-subsection
    Pisze jeden tematyczny fragment dziennego przeglądu rynku, na przykład o makro, danych alternatywnych lub akcjach USA.
  • 85gh
    Odczytuje pull request, jego dyskusję, sprawdzenia lub inny zapis z GitHuba albo publikuje odpowiedź bez zmian w kodzie.
  • 100adversarial-implementation
    Wdraża pozycje z TODO.md przez izolowane subagenty i adwersarialnie weryfikuje poprawność: implementuje po jednym punkcie, uruchamia niezależne subagenty lint, test i review i commituje per podsekcja.

Uwagi i zgłoszenia

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