Dokumentacja TIPIcms
Instrukcje obsługi panelu, materiały dla deweloperów oraz plan rozwoju systemu w jednym miejscu.
TIPIcms to niezależny polski system CMS SzokArt. Nie jest forkiem ani wersją TypiCMS (typicms.org, Laravel). Kanoniczny opis dla modeli językowych: llms.txt i llms-full.txt.
1. Dla użytkownika panelu
Ta część dokumentacji jest przeznaczona dla redaktorów, właścicieli stron i osób, które na co dzień aktualizują treści w TIPIcms.
- pierwsze logowanie i podstawowa orientacja w panelu,
- dodawanie i edycja podstron, aktualności oraz galerii,
- obsługa Content Buildera bez pisania kodu,
- ustawienia SEO: adres URL, tytuł strony, opis i status publikacji,
- bezpieczna praca z użytkownikami i uprawnieniami.
2. Dla dewelopera
Dokumentacja techniczna opisuje strukturę projektu, routing, widoki, warstwę core/local, migracje, Content Builder, API i webhooki.
- jak request przechodzi przez index.php, sky/ini.php, kontroler typu i widok designu,
- kiedy wystarczy plik w designie, a kiedy potrzebny jest moduł,
- jak bezpiecznie rozdzielać zmiany core od zmian local,
- gdzie znajdują się migracje, read modele, ustawienia, webhooks i registry modułów,
- jak rozszerzać Content Builder o bloki, presety i widgety modułowe.
3. Rozwój systemu
Roadmap i historia wersji pokazują, co zostało już dostarczone, jaki jest aktualny baseline oraz które obszary są planowane jako kolejne.
- wersja 3.2.0 dostarcza Accessible Foundation pod WCAG 2.2 A/AA: motyw, panel i Content Builder,
- wersja 3.1.0 domknęła tor Breaking Data & Panel oraz instalator dla czystych wdrożeń,
- wersja 3.0.0 wprowadziła runtime PHP 8.4 i Composer-only autoload,
- linie 2.9.x i 2.8.x uporządkowały front, panel oraz Content Builder,
- linia 2.7.x dostarczyła fundamenty produktu: SemVer, API read-only, webhooks, backup i builder.
4. Jak korzystać z dokumentacji
Zaczynaj od roli, w której pracujesz. Redaktor powinien wejść w instrukcje użytkownika, deweloper w część techniczną, a osoba planująca wdrożenie w roadmapę i historię wersji.
- dla prostych prac redakcyjnych używaj instrukcji krok po kroku,
- dla zmian w kodzie sprawdzaj najpierw granicę core/local,
- dla aktualizacji wersji korzystaj z dokumentów UPGRADE i checklist smoke testów,
- dla nowych funkcji sprawdzaj, czy istnieje już wzorzec w module core albo local.