-
Notifications
You must be signed in to change notification settings - Fork 112
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
Editorial pass for style, clarity, grammar, punctuation, syntax, spelling, etc. #1549
Conversation
cc: @msporny posting early so we don't overlap. I'll continue on this ... feel free to add here to the same PR if you wish. |
@decentralgabe This is great, I'll review and merge this weekend. It's important that we don't stomp on each other, I'm still working through Sections 5, 6, and 7, so please don't make commits to those sections in this PR (if you do, there'll be a terrible amount of conflicts for both of us). If you can take sections 8 and 9 next, that would be super helpful! |
bb75de3
to
5e95de0
Compare
index.html
Outdated
@@ -5023,7 +5024,7 @@ <h3>Personally Identifiable Information</h3> | |||
securing mechanism, need to be specifically designed to avoid correlation. | |||
[=Verifiable credentials=] that are specifically designed to prevent the leakage | |||
of personally identifiable information do exist. Individuals and implementers | |||
are urged to prefer these types of credentials over ones that are not designed | |||
are urged to prefer these credentials over ones that are not designed |
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.
are urged to prefer these credentials over ones that are not designed | |
are urged to prefer these credential types over ones that are not designed |
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.
are urged to prefer these credentials over ones that are not designed | |
are urged to prefer these [=credential=] types over types that are not designed |
index.html
Outdated
@@ -5992,10 +5993,10 @@ <h3>Unsigned Claims</h3> | |||
|
|||
<p> | |||
This specification allows [=credentials=] to be produced that are not secured by | |||
signatures or proofs of any kind. These types of [=credentials=] are often | |||
signatures or proofs of any kind. These [=credentials=] are often |
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.
signatures or proofs of any kind. These [=credentials=] are often | |
signatures or proofs of any kind. These class of [=credentials=] are often |
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.
Merged too quickly! Should have been either --
signatures or proofs of any kind. These [=credentials=] are often | |
signatures or proofs of any kind. These [=credential=] types are often |
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.
-- or --
signatures or proofs of any kind. These [=credentials=] are often | |
signatures or proofs of any kind. These classes of [=credential=] are often |
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.
-- or perhaps --
signatures or proofs of any kind. These [=credentials=] are often | |
signatures or proofs of any kind. Such [=credential=] are often |
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.
I provided a number of change suggestions, but other than those nits, LGTM.
THANK YOU for doing this top-to-bottom review; it gives me far more confidence that we have solid editorial coverage on a top-to-bottom read of the document.
Purely editorial, merging. |
@@ -338,8 +340,8 @@ <h2>Introduction</h2> | |||
The components that constitute a [=verifiable presentation=] | |||
</li> | |||
<li> | |||
An ecosystem where [=verifiable credentials=] and | |||
[=verifiable presentations=] are expected to be useful | |||
An ecosystem where one [=verifiable credentials=] |
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.
An ecosystem where one [=verifiable credentials=] | |
An ecosystem where [=verifiable credentials=] |
[=Credentials=] are integral to our daily lives; driver's licenses confirm | ||
our capability to operate motor vehicles, university degrees assert our level | ||
of education, and government-issued passports permit travel between countries. | ||
This specification provides a mechanism to express these sorts of | ||
[=credentials=] on the Web in cryptographically secure, privacy-respecting, | ||
and machine-verifiable way. |
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.
[=Credentials=] are integral to our daily lives; driver's licenses confirm | |
our capability to operate motor vehicles, university degrees assert our level | |
of education, and government-issued passports permit travel between countries. | |
This specification provides a mechanism to express these sorts of | |
[=credentials=] on the Web in cryptographically secure, privacy-respecting, | |
and machine-verifiable way. | |
[=Credentials=] are integral to our daily lives: driver's licenses confirm | |
our capability to operate motor vehicles, university degrees assert our level | |
of education, and government-issued passports attest to our citizenship when traveling between countries. | |
This specification provides a mechanism to express these sorts of | |
[=credentials=] on the Web in a cryptographically secure, privacy-respecting, | |
and machine-verifiable way. |
[=Credentials=] are integral to our daily lives; driver's licenses confirm | ||
our capability to operate motor vehicles, university degrees assert our level | ||
of education, and government-issued passports permit travel between countries. | ||
This specification provides a mechanism to express these sorts of | ||
[=credentials=] on the Web in cryptographically secure, privacy-respecting, | ||
and machine-verifiable way. These [=credentials=] provide |
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 paragraph fully repeats the Abstract
. That reads as an error, even if it is intentional (which I do not think it should be).
[=Credentials=] are integral to our daily lives; driver's licenses confirm | |
our capability to operate motor vehicles, university degrees assert our level | |
of education, and government-issued passports permit travel between countries. | |
This specification provides a mechanism to express these sorts of | |
[=credentials=] on the Web in cryptographically secure, privacy-respecting, | |
and machine-verifiable way. These [=credentials=] provide | |
[=Credentials=] are integral to our daily lives: driver's licenses confirm | |
our capability to operate motor vehicles, university degrees assert our level | |
of education, and government-issued passports attest to our citizenship when traveling between countries. | |
This specification provides a mechanism to express these sorts of | |
[=credentials=] on the Web in a cryptographically secure, privacy-respecting, | |
and machine-verifiable way. These [=credentials=] provide |
It is currently difficult to express education qualifications, healthcare | ||
data, financial account details, and other third-party [=verified=] | ||
machine-readable personal information on the Web. The challenge of expressing | ||
digital [=credentials=] on the Web hinders our ability to receive the same | ||
benefits physical [=credentials=] provide us in the real world. |
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.
It is currently difficult to express education qualifications, healthcare | |
data, financial account details, and other third-party [=verified=] | |
machine-readable personal information on the Web. The challenge of expressing | |
digital [=credentials=] on the Web hinders our ability to receive the same | |
benefits physical [=credentials=] provide us in the real world. | |
It is currently difficult to express educational qualifications, healthcare | |
data, financial account details, and other third-party-[=verified=] | |
personal information in a machine-readable way on the Web. The challenge of expressing | |
digital [=credentials=] on the Web hinders our ability to receive the same | |
benefits that physical [=credentials=] provide us in the real world. |
This specification standardizes a way of expressing [=credentials=] on the | ||
Web, ensuring they are cryptographically secure, privacy-respecting, and | ||
machine-verifiable. |
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 specification standardizes a way of expressing [=credentials=] on the | |
Web, ensuring they are cryptographically secure, privacy-respecting, and | |
machine-verifiable. | |
This specification standardizes a way of expressing [=credentials=] on the | |
Web that ensures they are cryptographically secure, privacy respecting, and | |
machine verifiable. |
@@ -368,14 +370,14 @@ <h3>What is a Verifiable Credential?</h3> | |||
Dutch passport, an American driving license, or a health insurance card) | |||
</li> | |||
<li> | |||
Information related to specific properties being asserted by | |||
Information related to specific properties asserted by | |||
the issuing authority about the [=subject=] (for example, nationality, | |||
the classes of vehicle entitled to drive, or date of birth) |
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.
the classes of vehicle entitled to drive, or date of birth) | |
date of birth, or the classes of vehicle they're qualified to drive) |
Evidence demonstrating how the [=subject=] met the qualifications required | ||
for issuing the [=credential=] (for example, a measurement, proof of | ||
citizenship, or test result) |
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.
Evidence demonstrating how the [=subject=] met the qualifications required | |
for issuing the [=credential=] (for example, a measurement, proof of | |
citizenship, or test result) | |
Evidence by which a [=subject=] was demonstrated to have satisfied the qualifications required | |
for issuing the [=credential=] (for example, a measurement, proof of | |
citizenship, or test result) |
physical [=credential=] represents. The addition of technologies, such as | ||
digital signatures, makes [=verifiable credentials=] more tamper-evident and |
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.
physical [=credential=] represents. The addition of technologies, such as | |
digital signatures, makes [=verifiable credentials=] more tamper-evident and | |
physical [=credential=] represents. Adding technologies such as | |
digital signatures can make [=verifiable credentials=] more tamper-evident and |
@decentralgabe -- Tag me when you're done. I should do my own top-to-bottom pass, and merge conflicts will be painful if we overlap. |
@TallTed FWIW, I think both @decentralgabe and I are done w/ our pass on Sections 1-4; they should be stable and allow you to raise a PR (or commit to main) your editorial changes to Sections 1-4. |
So far up to section 5.
Preview | Diff