Skip to content

Conversation

@akihikokuroda
Copy link
Contributor

@akihikokuroda akihikokuroda commented Jan 23, 2026

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code as added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

@github-actions
Copy link
Contributor

The PR description has been updated. Please fill out the template for your PR to be reviewed.

@mergify
Copy link

mergify bot commented Jan 23, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Enforce conventional commit

Wonderful, this rule succeeded.

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|release)(?:\(.+\))?:

@akihikokuroda akihikokuroda changed the title doc: add readme files in docs/examples docs: add readme files in docs/examples Jan 23, 2026
Copy link
Member

@psschwei psschwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 for adding readmes for the examples
Based on a quick sampling it doesn't seem like the examples are undergoing frequent revision (if they were, we'd need a strategy around keeping them up to date).

Signed-off-by: Akihiko Kuroda <akihikokuroda2020@gmail.com>
@planetf1
Copy link
Contributor

I think these are really useful, and will help with searches. LGTM

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.

doc: add readme file in each docs/examples directories

3 participants