Skip to content

docs: integration examples — 4 example projects#103

Merged
sepehr-safari merged 1 commit into
mainfrom
docs/examples
Jul 9, 2026
Merged

docs: integration examples — 4 example projects#103
sepehr-safari merged 1 commit into
mainfrom
docs/examples

Conversation

@sepehr-safari

Copy link
Copy Markdown
Member

Summary

Creates 4 standalone integration example projects in examples/:

  1. simple-trace/ — Parse a trace, detect failures, generate a Markdown report
  2. simple-csms/ — CSMS mock: validate messages, detect failures
  3. simulator-output/ — Process JSONL trace, generate HTML report
  4. ci-example/ — GitHub Actions workflow with ocpp-debugkit ci

Each example is self-contained (not part of pnpm workspace), has its own package.json, README, and synthetic sample data.

Also adds ESLint ignore for examples/ directory and links to examples from root README.

Closes #89

Checklist

  • examples/simple-trace/ — runnable, parses + detects + reports
  • examples/simple-csms/ — runnable, validates + detects
  • examples/simulator-output/ — runnable, JSONL + HTML report
  • examples/ci-example/ — GitHub Actions workflow + scenario files
  • All trace data is synthetic
  • Each example has a README with run instructions
  • examples/ is not part of the pnpm workspace (standalone projects)
  • Root README updated with link to examples
  • No changeset needed (examples are not published package content)
  • Lint, format check pass

@sepehr-safari sepehr-safari merged commit 8ea101c into main Jul 9, 2026
2 checks passed
@sepehr-safari sepehr-safari deleted the docs/examples branch July 9, 2026 07:18
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.

examples: integration examples

1 participant