moai-docs-generation

Documentation generation patterns for technical specs, API docs, user guides, and knowledge bases using real tools like Sphinx, MkDocs, TypeDoc, and Nextra. Use when creating docs from code, building doc sites, or automating documentation workflows.

1. Zainstaluj Sphinx i wymagane rozszerzenia poleceniem pip install sphinx sphinx-autodoc-typehints sphinx-rtd-theme myst-parser, lub wybierz inne narzędzie w zależności od języka projektu (TypeDoc dla TypeScript, MkDocs dla projektów ogólnych). 2. Zainicjuj projekt dokumentacji uruchamiając sphinx-quickstart docs (dla Sphinx) lub mkdocs new docs (dla MkDocs), co utworzy podstawową strukturę katalogów i plików konfiguracyjnych. 3. Skonfiguruj plik conf.py (Sphinx) lub mkdocs.yml (MkDocs), ustawiając rozszerzenia, motyw (np. sphinx-rtd-theme lub Material), oraz ścieżki do kodu źródłowego. 4. Dodaj adnotacje dokumentacyjne do kodu (docstringi w Pythonie, JSDoc w JavaScript) lub użyj autodoc do automatycznego generowania dokumentacji z kodu. 5. Uruchom sphinx-build -b html docs docs/_build (Sphinx) lub mkdocs build (MkDocs) aby wygenerować statyczną witrynę HTML. 6. Zintegruj proces generowania dokumentacji z potokiem CI/CD, aby dokumentacja aktualizowała się automatycznie przy każdym commicie.