writedocs

Dla zespołów programistycznych, które potrzebują publicznej strony z przewodnikami po produktach i dokumentacją API, WriteDocs zamienia repozytorium dokumentacji na GitHubie w hostowany portal dokumentacji. Strony można tworzyć w Markdownie lub MDX, porządkować je w sekcje nawigacyjne i sekcje produktów, a zmiany podglądać lokalnie za pomocą interfejsu CLI WriteDocs. Wypchnięcie aktualizacji do GitHuba automatycznie publikuje portal. Zespoły mogą dostosowywać wygląd i strukturę portalu, korzystać z szablonów stron i wielokrotnego użytku komponentów oraz generować strony dokumentacji API na podstawie plików OpenAPI. Strony API zawierają interaktywny panel, w którym programiści mogą wysyłać żądania i przeglądać odpowiedzi. WriteDocs może być odpowiednim rozwiązaniem dla zespołów, które swobodnie posługują się podejściem documentation-as-code i chcą utrzymywać przewodniki po produktach oraz dokumentację dla programistów razem z kodem.

Zastrzeżenie: WebCatalog nie jest powiązany, stowarzyszony, upoważniony ani wspierany przez writedocs ani w żaden sposób oficjalnie z nim związany. Wszystkie nazwy produktów, logo i marki są własnością ich odpowiednich właścicieli.