Skip to content

docs: AP-5359 OKF bundle for zcs-python-core - #31

Merged
PeppeIron merged 1 commit into
mainfrom
docs/AP-5359-okf-zcs-python-core
Nov 10, 2026
Merged

PeppeIron merged 1 commit into
mainfrom
docs/AP-5359-okf-zcs-python-core

Conversation

@PeppeIron

Copy link
Copy Markdown
Contributor

What

Adds the OKF bundle (okf/, OKF v0.2) for zcs-python-core, describing the library as seen by the services that use it, and links it from the README ("Documentation" section). Documentation only: no code, workflow or configuration changes.

What the bundle contains

Area Cards
Overview libreria.md (what it offers, install, undeclared dependencies)
API api/sessione.md, api/logger.md, api/eccezioni.md, api/telemetria.md
Behaviors comportamenti.md (missing context, global effects of the logger, counter errors, fields sent to Loki)
Consumers consumatori.md (15 services in production, 2 not in production, 5 libraries; required version on main and at the production tag)
History versioni.md (tags from 2025, incl. the 0.11.2 tag with less code than 0.11.2-rc2)
Operations operativita/configurazione.md, operativita/rilascio.md
Flow flussi/ciclo-di-vita-contesto-richiesta.md
Open issues questioni-aperte.md (prioritised: high / medium / low)

Status of the cards

All cards are status: draft, with no verified. They will be verified by a person before the PR leaves draft.

How it was checked

  • check_okf.py (front matter, sources, footnotes, relative links, secrets): no errors on 12 cards.
  • Claims are tied to files and lines. What was not read is marked "dedotto" or "da verificare".
  • The ZcsTelemetry counter errors (undeclared / missing labels, duplicate names) were reproduced locally in a temporary environment outside the repo, with prometheus_client 0.25.0.
  • Consumers: git grep on origin/main of every repo in the workspace; versions at the production tags read with git show <tag>; app_versions read from ml-follia-tesseract on 2026-11-10.
  • Release status of the GitHub releases read with gh release list / gh api.

Open issues

See okf/questioni-aperte.md. The most relevant: personal data (user email) in Loki tags where Loki is configured; nine different core versions in production; the 0.11.2 tag; JWT decoded without signature check in some consumers (a note for their own bundles).

Notes

  • No sandbox for libraries: this is the only PR, towards main.
  • A push to main does not start any workflow, so this PR does not need paths-ignore; the PR workflow builds and tests as usual.
  • The registration in aip-follia-knowledge is a separate PR, to be merged after this one (its links point to main).

🤖 Generated with Claude Code

Add the OKF bundle (okf/) describing the library as seen by its users:
overview, API (session, logger, exceptions, telemetry), behaviors,
consumers, version history, configuration, release and open issues.
All cards are draft, without verified. Link the bundle from the README.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@PeppeIron PeppeIron self-assigned this Nov 10, 2026
@PeppeIron
PeppeIron marked this pull request as ready for review November 10, 2026 17:22
@PeppeIron
PeppeIron merged commit 6e30dc1 into main Nov 10, 2026
1 check passed
@PeppeIron
PeppeIron deleted the docs/AP-5359-okf-zcs-python-core branch November 10, 2026 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant