docs: dokumentacja MkDocs + odchudzone README/CLAUDE.md + skill docs-sync#2
Merged
Merged
Conversation
…sync Rozdzielenie dokumentacji na trzy powierzchnie o jasnym przeznaczeniu: README (front door: instalacja + pierwsze uruchomienie), docs/ (pełna dokumentacja operacyjna na MkDocs Material → GitHub Pages) i CLAUDE.md (sterowanie agentem: niezmienniki, kontrakty, wskaźniki do plików). - docs/: 29 stron w 7 sekcjach (instalacja, konfiguracja, eksploatacja, monitoring, architektura, rozwiązywanie problemów, rozwój); treść zmigrowana i rozbudowana z README + CLAUDE.md - mkdocs.yml (Material, pl, walidacja kotwic) + docs/requirements.txt - .github/workflows/docs.yml: build --strict + gh-deploy na push do main - README: 702 → 219 linii (zostają tylko instalacja i wspólna konfiguracja + tabela linków do dokumentacji) - CLAUDE.md: ~30 KB → 11 KB (twarde niezmienniki dla agenta, reszta jako wskaźniki do docs/) - skill .claude/skills/docs-sync: mapa "co gdzie należy" + checklista zmiana→pliki + niezmienniki + brama mkdocs build --strict - .gitignore: przepuszcza .claude/skills/, chowa lokalne dane Claude i site/ - .pre-commit-config: check-yaml wyklucza mkdocs.yml (tagi !!python/name:) Weryfikacja: mkdocs build --strict (0 błędów), ./tests/test_makefile.sh (119 passed, 0 failed). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Co i dlaczego
Dotąd README (702 linie) i CLAUDE.md (~30 KB) duplikowały większość treści, co prowadziło do dryfu. Ten PR rozdziela dokumentację na trzy powierzchnie o jasnym przeznaczeniu i wprowadza narzędzie utrzymujące je w synchronizacji.
README.mddocs/(MkDocs → GitHub Pages)CLAUDE.mdZmiany
docs/— 29 stron w 7 sekcjach (instalacja, konfiguracja, eksploatacja, monitoring, architektura, rozwiązywanie problemów, rozwój). Treść zmigrowana i rozbudowana z README + CLAUDE.md (m.in. architektura konfiguracji/force-sync, healthchecks+autoheal, zadania Ofelii, retencja Loki, kolektory Netdata, slow queries, dashboardy, kontrakt backwards-compat).mkdocs.yml(polski, dark mode, nawigacja zakładkowa, walidacja kotwic) +docs/requirements.txt..github/workflows/docs.yml—mkdocs build --strict+mkdocs gh-deployna push domain(ze ścieżekdocs/**,mkdocs.yml).logging:przy nowych serwisach, kontrakt.env), reszta jako wskaźniki dodocs/.docs-sync(.claude/skills/docs-sync/, commitowany do repo) — mapa „co gdzie należy", checklista zmiana → pliki do dotknięcia, niezmienniki, bramamkdocs build --strict. Użyty do przeprowadzenia tej migracji..gitignore— przepuszcza.claude/skills/(skill współdzielony), chowa lokalne dane Claude isite/..pre-commit-config—check-yamlwykluczamkdocs.yml(tagi!!python/name:Material nie są safe-loadowalne; waliduje jemkdocs build --strict).Po stronie maintainera (wymagane do publikacji)
gh-pages(workflow utworzy go przy pierwszym uruchomieniu).site_urlzakładahttps://iplweb.github.io/bpp-deploy/.Weryfikacja
mkdocs build --strictz walidacją kotwic — 0 błędów/warningów./tests/test_makefile.sh— 119 passed, 0 failed🤖 Generated with Claude Code