From 4ce59a257ef4fa689acf2d15bca0b3f8242304ea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mateusz=20Miko=C5=82ajczyk?= Date: Wed, 13 Dec 2023 17:51:04 +0100 Subject: [PATCH] cleanup docs --- README.md | 12 +++++++++++- docs/content/instalacja.md | 6 +----- docs/content/komendy/_index.md | 7 ------- docs/content/komendy/upload/_index.md | 5 ----- 4 files changed, 12 insertions(+), 18 deletions(-) delete mode 100644 docs/content/komendy/_index.md delete mode 100644 docs/content/komendy/upload/_index.md diff --git a/README.md b/README.md index 7531714..6db7073 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,18 @@ npm ci npm run docs:dev ``` -Dokumentacja zostanie udostępniona na porcie 5137 +Dokumentacja zostanie udostępniona na porcie 5173 ( http://localhost:5173 ) ## Plik PDF Przy każdym buildzie programu generowany jest PDF z dokumentacją. Można go znaleźć w środku archiwum oraz w artefaktach buildu + +Możesz też własnoręcznie wygenerować plik PDF używając następujących komend: + +```shell +cd docs +npm ci +npm run export-pdf +``` + +(w katalogu `docs` pojawi się plik `ksef-dokumentacja-uzytkownika.pdf`) diff --git a/docs/content/instalacja.md b/docs/content/instalacja.md index 0e58b56..0e2d9f5 100644 --- a/docs/content/instalacja.md +++ b/docs/content/instalacja.md @@ -1,8 +1,4 @@ ---- -weight: 100 -title: "Instalacja" -toc: true ---- +# Instalacja programu Aby pobrać najnowszą wersję klienta KSeF masz dwie opcje: diff --git a/docs/content/komendy/_index.md b/docs/content/komendy/_index.md deleted file mode 100644 index 4b8bb03..0000000 --- a/docs/content/komendy/_index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -weight: 999 -title: "Dostępne komendy" -toc: true ---- - -Klient KSeF obsługuje kilka komend. W tych rozdziałach postaram się je z grubsza opisać aby ułatwić obsługę programu. diff --git a/docs/content/komendy/upload/_index.md b/docs/content/komendy/upload/_index.md deleted file mode 100644 index 18451de..0000000 --- a/docs/content/komendy/upload/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: Upload (przesyłka faktur) ---- - -KSeF przewiduje dwa tryby wysyłki faktur - wsadowy (batch) oraz interaktywny. W przypadku sesji interaktywnej wszystkie faktury pakujemy do archiwum, generujemy plik metadanych który następnie podpisujemy a na samym końcu wysyłamy zaszyfrowane archiwum do ministerstwa. Minusem (lub plusem - w zależności jak na to patrzeć) jest to, że w przypadku błędu walidacji jednej faktury odrzucona zostaje cała paczka.