Skip to content

docs: add AGENTS.md and refactor examples to use new()#110

Merged
Suhaibinator merged 1 commit into
mainfrom
ptr
May 1, 2026
Merged

docs: add AGENTS.md and refactor examples to use new()#110
Suhaibinator merged 1 commit into
mainfrom
ptr

Conversation

@Suhaibinator

Copy link
Copy Markdown
Owner
  • Add comprehensive AGENTS.md documentation for Codex agents with build commands, architecture overview, and design patterns
  • Replace custom router.Ptr() helper with idiomatic Go new() function in examples for pointer creation

- Add comprehensive AGENTS.md documentation for Codex agents with build commands, architecture overview, and design patterns
- Replace custom router.Ptr() helper with idiomatic Go new() function in examples for pointer creation
@codecov

codecov Bot commented May 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.49%. Comparing base (e77991d) to head (acdd29a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #110      +/-   ##
==========================================
- Coverage   97.49%   97.49%   -0.01%     
==========================================
  Files          18       18              
  Lines        1875     1873       -2     
==========================================
- Hits         1828     1826       -2     
  Misses         35       35              
  Partials       12       12              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: acdd29a701

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread pkg/router/config.go
Comment on lines 232 to 234
// When used with RegisterGenericRoute, the framework automatically handles decoding the
// request and encoding the response using the specified Codec.
type GenericHandler[T any, U any] func(r *http.Request, data T) (U, error)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Restore Ptr helper to preserve public API compatibility

Deleting the exported router.Ptr function in this commit is a source-compatible breaking change for existing consumers that still configure auth levels as router.Ptr(router.AuthRequired). Upgrading to this revision will make those downstream builds fail even though the change is framed as a docs/examples refactor, so this should either be kept as a deprecated shim or called out as an intentional breaking change with a migration path.

Useful? React with 👍 / 👎.

@Suhaibinator Suhaibinator merged commit 36bd9f8 into main May 1, 2026
11 checks passed
@Suhaibinator Suhaibinator deleted the ptr branch May 1, 2026 23:09
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