Skip to content

Integrate Python examples into shared Chronicle documentation #5

Description

@woksin

User need

Python users should find Python examples through Chronicle's shared client documentation only after those examples are executable against the client.

Desired behavior

Integrate Chronicle.Python into the shared Chronicle client-snippet and documentation synchronization system after the first authenticated append milestone passes.

Acceptance evidence

  • Adds Documentation/client-snippets/** only for exercised Python workflows.
  • Adds a validator that compiles or executes snippets against the local package.
  • Adds client-snippet verification and documentation-sync workflows.
  • Registers the repository in the Documentation repository's Chronicle client configuration.
  • Uses explicit unsupported snippets where a shared workflow is not implemented.
  • Shared documentation checks and the documentation site build pass.

Non-goals

  • Claiming parity with another Chronicle client.
  • Duplicating shared Chronicle concept documentation in this repository.
  • Publishing Python installation instructions before a package exists.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    blockedWaiting on a named dependency or gatedocumentationDocumentation and executable exampleskind/featureNew client capability

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions