Repository navigation
docs: AP-5359 OKF bundle for zcs-python-core - #31
Merged
Merged
Conversation
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>
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.
What
Adds the OKF bundle (
okf/, OKF v0.2) forzcs-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
libreria.md(what it offers, install, undeclared dependencies)api/sessione.md,api/logger.md,api/eccezioni.md,api/telemetria.mdcomportamenti.md(missing context, global effects of the logger, counter errors, fields sent to Loki)consumatori.md(15 services in production, 2 not in production, 5 libraries; required version on main and at the production tag)versioni.md(tags from 2025, incl. the0.11.2tag with less code than0.11.2-rc2)operativita/configurazione.md,operativita/rilascio.mdflussi/ciclo-di-vita-contesto-richiesta.mdquestioni-aperte.md(prioritised: high / medium / low)Status of the cards
All cards are
status: draft, with noverified. 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.ZcsTelemetrycounter errors (undeclared / missing labels, duplicate names) were reproduced locally in a temporary environment outside the repo, withprometheus_client0.25.0.git greponorigin/mainof every repo in the workspace; versions at the production tags read withgit show <tag>;app_versionsread fromml-follia-tesseracton 2026-11-10.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; the0.11.2tag; JWT decoded without signature check in some consumers (a note for their own bundles).Notes
main.maindoes not start any workflow, so this PR does not needpaths-ignore; the PR workflow builds and tests as usual.aip-follia-knowledgeis a separate PR, to be merged after this one (its links point tomain).🤖 Generated with Claude Code