Skip to content

Checks: validate client JSON config snippets in CI to prevent stale or unsafe examples #34

Description

@francescobianco

Summary

The project ships multiple user-facing JSON config examples under docs/settings/, but there is no machine check validating that they remain parseable and free from token-like literals or stale keys.

Reproduction

  1. Inspect docs/settings/*.json.
  2. Notice these files are intended for direct copy-paste into clients.
  3. There is no automated validation step for them.

Expected

A small CI check should validate JSON syntax and catch obviously unsafe placeholders or stale config shapes.

Actual

These examples can drift silently.

Why this is not just docs

Broken client config snippets create real onboarding failures and support load.

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

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions