Skip to content

docs(examples): add overview and clarify npm packaging - #648

Merged
kmbroai merged 1 commit into
mainfrom
dev/kyleb/examples-readme
Aug 25, 2026
Merged

docs(examples): add overview and clarify npm packaging#648
kmbroai merged 1 commit into
mainfrom
dev/kyleb/examples-readme

Conversation

@kmbroai

@kmbroai kmbroai commented Aug 25, 2026

Copy link
Copy Markdown
Collaborator

Summary

Add an overview for the repository examples and document that they are not shipped in the npm package.

Changes

  • Add examples/README.md with links to the findings CSV template and custom validation demo.
  • Explain that the top-level examples are repository-only, while the bundled plugin's own example artifacts remain packaged.
  • Keep the existing package configuration unchanged: the package lives in sdk/typescript, its files list excludes the top-level examples, and the existing package checker rejects unexpected files.

Testing

  • Prettier check of examples/README.md: passed.
  • Checked every relative link in the new README: passed.
  • pnpm pack --pack-destination ../../dist (including the TypeScript build): passed.
  • node scripts/check-package.mjs ../../dist/openai-codex-security-0.1.20.tgz plugin-files.json: passed, validating 269 archive entries.
  • Inspected the generated tarball: no top-level repository examples or examples README; all four bundled plugin example artifacts remain present.
  • git diff --check origin/main...HEAD: passed.
  • Full unit tests and installed-package smoke tests were not run because this change only adds documentation.

Risk and rollout

Low risk. Documentation only; no CLI, runtime, dependency, or package configuration changes. No rollout steps are required.

Public disclosure review

  • No customer, partner, prospect, or user identities, data, or identifying details are included.
  • No credentials, personal data, private source, scan findings, or nonpublic links or tickets are included.
  • I reviewed the branch name, title, description, commits, changes, comments, logs, screenshots, attachments, and links for public disclosure.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Aug 25, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 25, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
🔒 Security Review Completed 2026-08-25T22:28:21.647354Z a6cd1bc PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@kmbroai
kmbroai merged commit b054e8b into main Aug 25, 2026
77 of 83 checks passed
@kmbroai
kmbroai deleted the dev/kyleb/examples-readme branch August 25, 2026 23:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants