Przejdź do treści
Biblioteka skilli
Dokumenty i biuro · Pisanie

contribute-docs

/contribute-docs

Tworzy i edytuje dokumentację oraz przykłady NeMo Relay zgodnie z konwencjami repozytorium: MDX, publiczne API, integracje i historia wydań.

Repozytorium
nemo-relay ↗
Licencja
Apache-2.0
Ostatnia zmiana repozytorium
26.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 26.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

Tworzy i edytuje dokumentację oraz przykłady NeMo Relay zgodnie z konwencjami repozytorium: MDX, publiczne API, integracje i historia wydań.

Oryginalny opis (EN)

Author or edit NeMo Relay documentation or examples when repository-specific MDX, public API, integration, or release-history conventions matter. Do not use for review-only requests or incidental prose edits in code.

Jak działa

  1. Rules
  2. Checklist
  3. References
Sekcje z nagłówków SKILL.md, w oryginale · 51 linii, 377 słów
Podgląd SKILL.md
---
name: contribute-docs
description: Author or edit NeMo Relay documentation or examples when repository-specific MDX, public API, integration, or release-history conventions matter. Do not use for review-only requests or incidental prose edits in code.
license: Apache-2.0
---


# Contribute Docs Or Examples

Use this skill when authoring docs-only or example-heavy changes.

## Rules

- Prefer the documented public API, not internal shortcuts
- Keep package names, repo references, and build commands current
- When documenting contribution workflow, require an issue before external contribution PRs and note that NVIDIA contributors may use a GitHub or Linear issue.
- Update entry-point docs when examples or reading paths change
- Keep release-process and release-notes guidance in repo-maintainer docs such as
  `RELEASING.md`, not as user-facing docs pages or `CHANGELOG.md`
- Keep stable user-facing wrappers at `scripts/` root in docs and examples;
  only point at namespaced helper paths when documenting internal maintenance
  work
- When detailed dynamic plugin guides exist, keep Rust native plugin examples,
  Python worker plugin examples, and `grpc-v1` protocol details on separate
  pages.
- Dynamic plugin manifests must exclude Relay versions before 0.8. Recommend
  `compat.relay = ">=0.8.0,<1.0"`; open-ended or narrower 0.8-or-newer ranges
  are valid when intentional.
- In MDX files, top-of-file comments must use JSX comment delimiters:
  `{/*` to open and `*/}` to close. Do not use HTML comments for MDX SPDX
  headers.
- Render images, diagrams, tables, and other visual content at representative
  page widths. Size visual content for legibility and complete access without
  clipping. Choose responsive scaling, reflow, or overflow based on the content,
  and scope visual-specific styling as narrowly as practical.

## Checklist

- [ ] `README.md` or `docs/index.yml` updated when entry points changed
- [ ] Relevant getting-started or reference docs updated
- [ ] Example commands still match current package names and paths
- [ ] Relevant package or crate `README.md` files updated when examples or binding guidance changed
- [ ] Dynamic plugin entry pages link to native, worker, Rust example, Python
      example, and protocol pages when those pages exist
- [ ] New or regenerated MDX files use `{/* ... */}` for top-of-file SPDX comments
- [ ] Images, diagrams, tables, and custom visual content remain legible and
      fully accessible at representative desktop and narrow page widths
- [ ] Release-policy docs still point to GitHub Releases as the only release-history source of truth
- [ ] Run `just docs` when the docs site changed; `./scripts/build-docs.sh html` remains the compatibility wrapper

## References

- `CONTRIBUTING.md`
- `RELEASING.md`
- `docs/contribute/testing-and-docs.mdx`

Wersje

W bazie nie ma innych skilli o nazwie contribute-docs.

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

  • 100review-doc-style
    Sprawdza dokumentację, przykłady i publiczne teksty NeMo Relay pod kątem stylu technicznego NVIDIA, terminologii i zgodności z repozytorium.
  • 100nemo-relay-migrate-from-flow
    Migruje aplikacje, przykłady i repozytoria z NeMo Flow do NeMo Relay w Pythonie, Rust, Node.js, Go, CLI i konfiguracji.
  • 100draft-release-notes
    Porównuje gałęzie wydań NeMo Relay i przygotowuje lub aktualizuje notatki o wydaniu w dokumentacji, zbierając dowody zmian między wersjami.
  • 100draft-release-notes
    Porównuje wydania NVIDIA NeMo Fabric i przygotowuje treść GitHub Release oraz uzasadnioną aktualizację not wydania w witrynie dokumentacji, na podstawie zweryfikowanych dowodów.
  • 100test-go-binding
    Buduje i testuje wiązanie Go do NeMo Relay: zmiany w go/nemo_relay oraz kontrole integracji z Go.
  • 100review-doc-style
    Sprawdza dokumentację, przykłady i zmiany w dokumentach NeMo Fabric pod kątem stylu technicznego NVIDIA, terminologii, zgodności z repozytorium i aktualnego zachowania publicznego.

Uwagi i zgłoszenia

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