review-rust-docs

Skill do przeglądu dokumentacji modułów i bibliotek Rust. Sprawdza, czy komentarze, opisy funkcji i dokumentacja spełniają wytyczne jakości projektu RediSearch. Przydatny po zmianach w kodzie Rust — analizuje pojedyncze pliki, moduły lub całe katalogi i generuje raport z uwagami dotyczącymi niezgodności.

1. Przygotuj ścieżkę do pliku lub katalogu Rust, który chcesz sprawdzić. Jeśli ścieżka nie zawiera src/, skill automatycznie założy, że znajduje się w src/redisearch_rs (np. numeric_range_tree będzie interpretowany jako src/redisearch_rs/numeric_range_tree).

2. Uruchom skill, przekazując ścieżkę jako argument. Możesz sprawdzić jeden plik, moduł lub wiele plików naraz, podając je jako oddzielne argumenty.

3. Jeśli wskazana ścieżka to katalog, skill automatycznie przeanalizuje dokumentację wszystkich plików Rust w tym katalogu.

4. Skill przeczyta dokumentację i porówna ją z wytycznymi zawartymi w rust-docs-guidelines. Wytyczne obejmują standardy formatowania komentarzy, opisy funkcji, dokumentację publicznych interfejsów i inne wymagania jakości.

5. Otrzymasz raport zawierający listę wszystkich miejsc, w których dokumentacja nie spełnia standardów. Dla każdego znalezionego problemu raport zawiera wyjaśnienie przyczyny niezgodności i sugestię poprawy.

6. Przejrzyj raport i zastosuj sugerowane zmiany w dokumentacji swoich modułów Rust, aby dostosować je do standardów projektu.