-
Notifications
You must be signed in to change notification settings - Fork 41
docs/adr: fix typos and wording in ADRs #420
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
WalkthroughDocumentation-only changes: corrected minor grammar/typos across three ADR files (adr-001, adr-002, adr-003). No code, API, or behavioral modifications. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (4)
adr/adr-002-create-account-op.md (2)
9-9: Optional wording polish for readability.
Consider tightening the sentence and using an em dash and parenthetical example:
- “centralizing account creation—… that they own a resource (e.g., a phone number) via OTP.”
Also, “via OTP” reads a bit cleaner than “via an OTP.”-The de facto solution to this problem is by centralizing the account creation - a service exists that signs off on an account creation event after a user verifies to the central entity that they own some resource, i.e. a phone number via an OTP. +The de facto solution is to centralize account creation—an entity signs off on account creation after the user proves ownership of a resource (e.g., a phone number) via OTP.
5-5: IMT vs JMT terminology consistency across ADRs.
This ADR refers to “IMT”, while ADR-003 (Line 12) quotes ADR-002 with “JMT”. Please confirm which term is canonical and unify across ADRs to avoid confusion.adr/adr-001-checkpoint-snarks.md (1)
259-259: Minor style: format method name and consider direct voice.
Wrap the method name in backticks and switch to an imperative tone for clarity.-We also need to implement a find_and_verify_latest_checkpoint method to scan backwards from the current height to find and verify the latest checkpoint SNARK. +Implement a `find_and_verify_latest_checkpoint` method to scan backward from the current height and verify the latest checkpoint SNARK.adr/adr-003-service-registration.md (1)
93-93: Tighten sentence and code-format identifiers.
Consider backticks around identifiers and a small rephrase for flow.-This differs from the existing implementation significantly, whose only account source is a SignedBySequencer. Further adjustments were made to AddKey and RevokeKey to enable hashchain verification using a SignatureBundle as originally intended. +This differs significantly from the existing implementation, whose only account source is `SignedBySequencer`. Further adjustments were made to `AddKey` and `RevokeKey` to enable hashchain verification using a `SignatureBundle`, as originally intended.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (3)
adr/adr-001-checkpoint-snarks.md(1 hunks)adr/adr-002-create-account-op.md(1 hunks)adr/adr-003-service-registration.md(1 hunks)
🔇 Additional comments (3)
adr/adr-002-create-account-op.md (1)
9-9: Good catch: “an OTP” is correct.
The article usage is now grammatically correct. No behavior/spec meaning changed.adr/adr-001-checkpoint-snarks.md (1)
259-259: Grammar fix looks right.
“implement” (not “implemented”) matches the intent and aligns with the method defined below.adr/adr-003-service-registration.md (1)
93-93: Typo fix confirmed.
“Further” is correct; the sentence reads properly now.
Summary by CodeRabbit