Skip to content

correct repository docs#6

Merged
iarunsaragadam merged 1 commit into
mainfrom
codex/docs-accuracy-hardening
Jun 1, 2026
Merged

correct repository docs#6
iarunsaragadam merged 1 commit into
mainfrom
codex/docs-accuracy-hardening

Conversation

@iarunsaragadam

Copy link
Copy Markdown
Contributor

Summary

  • align README quick-start endpoints with docker-compose
  • stop advertising audit export as shipped behavior
  • remove stale rate-limiter/quota wording from issue and PR templates
  • remove stale version-specific wording from the fail-closed limiter warning

Tests

  • go test -count=1 ./cmd/keychain
  • actionlint .github/workflows/*.yml
  • git diff --check

Remove stale rate-limiter template text and align README endpoints with docker-compose. Document that audit export is not implemented instead of advertising it as shipped behavior.
@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown

All committers have signed the CLA; thanks.

@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: d6bdc6c2bd

ℹ️ 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 cmd/keychain/main.go
Comment on lines +176 to +177
// failClosedRateLimiter does not call a real rate-limiter; if a key carries
// limit_refs, verify is denied. Keys without limit_refs are unaffected.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Delete the behavior-restating rate-limiter comment

AGENTS.md says comments are for the why and specifically forbids comments that restate what the code does. This updated comment only repeats that the fail-closed limiter denies keys with limit_refs while leaving other keys unaffected, which is already visible from the implementation and VerifyKey flow. Remove it or replace it with the non-obvious rationale for why this binary ships a fail-closed limiter.

Useful? React with 👍 / 👎.

@iarunsaragadam iarunsaragadam merged commit 7c75e15 into main Jun 1, 2026
14 checks passed
@iarunsaragadam iarunsaragadam deleted the codex/docs-accuracy-hardening branch June 1, 2026 17:37
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