-
Notifications
You must be signed in to change notification settings - Fork 5
Resolve Section Edits #295
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
Added missing links, small grammar / capitalization updates, added missing acronyms / formal names.
| # Resolve | ||
|
|
||
| Resolving a **did:btcr2** identifier iteratively builds a DID document by applying [BTCR2 Updates][BTCR2 Update] to an [Initial DID Document] that have been committed to the Bitcoin blockchain by [Authorized Beacon Signals][Authorized Beacon Signal]. The [Initial DID Document] is either deterministically created from the DID or provided by [Sidecar Data]. | ||
| Resolving a **did:btcr2** identifier iteratively builds a DID document by applying [BTCR2 Updates][BTCR2 Update] to an [Initial DID Document] that has been committed to the Bitcoin blockchain by [Authorized Beacon Signals][Authorized Beacon Signal]. The [Initial DID Document] is either deterministically created from the DID or provided by [Sidecar Data]. |
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.
Isn't "have" grammatically correct? Updates have been committed.
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.
From the structure of the sentence, it looks like we're using the plural "have" with the singular "an Initial DID Document." If "have" refers to the BTCR2 Updates, could we rephrase to "resolving a did:btcr2 identifier iteratively builds a DID document by applying BTCR2 Updates that have been committed to the Bitcoin blockchain by Authorized Beacon Signals to an Initial DID Document"?
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.
Updates are committed to the blockchain, not initial DID documents. I'd be happy to see any improvements that can reduce confusion. 😄 It looks like Codex agrees with your change. It independently made the following suggested change:
| Resolving a **did:btcr2** identifier iteratively builds a DID document by applying [BTCR2 Updates][BTCR2 Update] to an [Initial DID Document] that has been committed to the Bitcoin blockchain by [Authorized Beacon Signals][Authorized Beacon Signal]. The [Initial DID Document] is either deterministically created from the DID or provided by [Sidecar Data]. | |
| Resolving a **did:btcr2** identifier iteratively builds a DID document by applying [BTCR2 Updates][BTCR2 Update] committed to the Bitcoin blockchain by [Authorized Beacon Signals][Authorized Beacon Signal] to an [Initial DID Document]. The [Initial DID Document] is either deterministically created from the DID or provided by [Sidecar Data]. |
| 1. [Establishes `current_document`](#establish-current-document) from the DID or from [Sidecar Data]. | ||
| 2. Repeats the following loop: | ||
| * [Process Beacon Signals](#process-beacon-signals) to populate `updates` from the beacon services in `current_document`. | ||
| * [Process Beacon Signals](#process-beacon-signals) to populate `updates` from the Beacon services in `current_document`. |
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.
This should not be capitalized, it is not referring to a proper noun nor a specific term in the terminology.
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.
Ok! This capitalization was a discussion previously, so this is a good clarification. Does this also apply to "map" when not using the full term Beacon Announcement Map?
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.
Does this also apply to "map" when not using the full term Beacon Announcement Map?
Ah, that depends on the context! When referring to the "map" data structure defined by WHATWG Infra, I have been capitalizing it. Infra and DID-Core do not capitalize it, so maybe we should not.
Added missing links, small grammar / capitalization updates, added missing acronyms / formal names.
Should the Apply Update section be numbered to match the numbered steps in Process Updates Array?