Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) [year] [fullname]
Copyright (c) 2026 Stacking

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

<div align="center">
<br>
<a href="https://docs.stacking.me/ksef2/sdk/intro/" title="ksef2 documentation">
<a href="https://docs.stacking.me/ksef2/sdk/getting-started/overview/" title="ksef2 documentation">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/stacking-hq/ksef2/main/docs/assets/logo-light.png">
<img src="https://raw.githubusercontent.com/stacking-hq/ksef2/main/docs/assets/logo-dark.png" alt="ksef2" width="320">
Expand Down Expand Up @@ -137,7 +137,7 @@ ksef2 profile create prod-token \
ksef2 profile use prod-token

# example usage of the cli
ksef2 --profile prod-token invoices metadata \
ksef2 --profile prod-token invoices list \
--role seller \
--date-from 2026-01-01T00:00:00Z
```
Expand Down Expand Up @@ -219,10 +219,11 @@ invoice downloads after KSeF assigns invoice numbers.

## Documentation

- Online docs: <https://docs.stacking.me/ksef2/sdk/intro/>
- Online docs: <https://docs.stacking.me/ksef2/sdk/getting-started/overview/>
- Quickstart: <https://docs.stacking.me/ksef2/sdk/getting-started/quickstart/>
- Workflow guides: <https://docs.stacking.me/ksef2/sdk/workflows/overview/>
- API reference: <https://docs.stacking.me/ksef2/sdk/reference/api-signatures/>
- How-to guides: <https://docs.stacking.me/ksef2/sdk/how-to-guides/overview/>
- Public API contract: <https://docs.stacking.me/ksef2/sdk/reference/public-api/>
- Python API reference: <https://docs.stacking.me/ksef2/sdk/reference/api/>
- Source docs: [`docs/en`](https://github.com/stacking-hq/ksef2/tree/main/docs/en) and [`docs/pl`](https://github.com/stacking-hq/ksef2/tree/main/docs/pl)
- Runnable examples: [`scripts/examples`](https://github.com/stacking-hq/ksef2/tree/main/scripts/examples)

Expand Down
13 changes: 7 additions & 6 deletions README.pl.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

<div align="center">
<br>
<a href="https://docs.stacking.me/ksef2/pl/sdk/intro/" title="dokumentacja ksef2">
<a href="https://docs.stacking.me/ksef2/pl/sdk/getting-started/overview/" title="dokumentacja ksef2">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/stacking-hq/ksef2/main/docs/assets/logo-light.png">
<img src="https://raw.githubusercontent.com/stacking-hq/ksef2/main/docs/assets/logo-dark.png" alt="ksef2" width="320">
Expand Down Expand Up @@ -90,7 +90,7 @@ Wybierz metodę uwierzytelnienia pasującą do środowiska, z którym pracujesz.

```python
from ksef2 import Client, Environment
from ksef2.core.xades import (
from ksef2.xades import (
load_certificate_from_pem,
load_private_key_from_pem,
)
Expand Down Expand Up @@ -140,7 +140,7 @@ ksef2 profile create prod-token \
ksef2 profile use prod-token

# przykładowe użycie CLI
ksef2 --profile prod-token invoices metadata \
ksef2 --profile prod-token invoices list \
--role seller \
--date-from 2026-01-01T00:00:00Z
```
Expand Down Expand Up @@ -222,10 +222,11 @@ pobierania paczek i bezpośredniego pobierania faktur.

## Dokumentacja

- Dokumentacja online: <https://docs.stacking.me/ksef2/pl/sdk/intro/>
- Dokumentacja online: <https://docs.stacking.me/ksef2/pl/sdk/getting-started/overview/>
- Quickstart: <https://docs.stacking.me/ksef2/pl/sdk/getting-started/quickstart/>
- Przepływy: <https://docs.stacking.me/ksef2/pl/sdk/workflows/overview/>
- API reference (EN): <https://docs.stacking.me/ksef2/sdk/reference/api-signatures/>
- Przewodniki praktyczne: <https://docs.stacking.me/ksef2/pl/sdk/how-to-guides/overview/>
- Kontrakt publicznego API: <https://docs.stacking.me/ksef2/pl/sdk/reference/public-api/>
- Referencja API Pythona (EN): <https://docs.stacking.me/ksef2/sdk/reference/api/>
- Źródła dokumentacji: [`docs/en`](https://github.com/stacking-hq/ksef2/tree/main/docs/en) i [`docs/pl`](https://github.com/stacking-hq/ksef2/tree/main/docs/pl)
- Uruchamialne przykłady: [`scripts/examples`](https://github.com/stacking-hq/ksef2/tree/main/scripts/examples)

Expand Down
26 changes: 26 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# SDK documentation source layout

This `docs/` tree is product-owned source prose. The published Starlight site
copies it into `ksef2-docs/src/content/docs/sdk/` during docs sync.

Keep the source tree aligned with the published sidebar groups:

- `getting-started/`: orientation and quickstart pages.
- `concepts/`: explanations of KSeF domain objects and workflow mechanics.
- `how-to-guides/`: task pages with action-oriented filenames.
- `reference/`: stable contracts, exact behavior, and low-level API notes.
- `contributing/`: maintainer-facing docs.

`docs.manifest.json` is the index for authored SDK documentation. Add each
published page there under the right category, using a locale-relative path such
as `how-to-guides/send-invoices.mdx`. The `en/` and `pl/` trees must stay
mirrored for every path listed in the manifest.

For manifest-backed docs, the published site copies only Markdown pages indexed
by `docs.manifest.json`. Keep draft, legacy, or migration notes outside the
manifest when they should not become public routes, or delete them once they no
longer have a source role.

Do not commit generated API reference pages here. The Python API reference is
generated by `ksef2-docs` from SDK source code during sync and appended to the
Starlight sidebar by the docs app.
Binary file added docs/assets/ksef2-cli-dark-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/ksef2-cli-light-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/ksef2-mcp-dark-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/ksef2-mcp-light-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/logo-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/logo-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading