Skip to content

docs: add integration guide for instrument-hooks#24

Draft
not-matthias wants to merge 2 commits intomainfrom
cod-2503-add-documentation-for-using-instrument-hooks
Draft

docs: add integration guide for instrument-hooks#24
not-matthias wants to merge 2 commits intomainfrom
cod-2503-add-documentation-for-using-instrument-hooks

Conversation

@not-matthias
Copy link
Copy Markdown
Member

Summary

  • Adds a comprehensive example/README.md targeting integration authors building CodSpeed support for new languages/frameworks
  • Covers the full integration lifecycle: initialization, benchmark control, URI conventions, flamegraph markers, and testing
  • Documents __codspeed_root_frame__ requirement with Rust and C examples
  • Includes simulation vs walltime differences and common pitfalls

Closes COD-2503

Test plan

  • Review doc accuracy against existing integrations (codspeed-rust, codspeed-cpp, codspeed-go)
  • Verify code snippets compile / are correct
  • Check links resolve

Adds a comprehensive README to the example/ directory targeting
integration authors building CodSpeed support for new languages.
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.

1 participant