Skip to content
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

Merged
merged 5 commits into from
Aug 17, 2024

Conversation

decentralgabe
Copy link
Contributor

@decentralgabe decentralgabe commented Aug 16, 2024

So far up to section 5.


Preview | Diff

@decentralgabe
Copy link
Contributor Author

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.

@msporny
Copy link
Member

msporny commented Aug 16, 2024

@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!

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
signatures or proofs of any kind. These [=credentials=] are often
signatures or proofs of any kind. These class of [=credentials=] are often

Copy link
Member

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 --

Suggested change
signatures or proofs of any kind. These [=credentials=] are often
signatures or proofs of any kind. These [=credential=] types are often

Copy link
Member

Choose a reason for hiding this comment

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

-- or --

Suggested change
signatures or proofs of any kind. These [=credentials=] are often
signatures or proofs of any kind. These classes of [=credential=] are often

Copy link
Member

Choose a reason for hiding this comment

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

-- or perhaps --

Suggested change
signatures or proofs of any kind. These [=credentials=] are often
signatures or proofs of any kind. Such [=credential=] are often

index.html Outdated Show resolved Hide resolved
Copy link
Member

@msporny msporny left a 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.

@msporny msporny marked this pull request as ready for review August 17, 2024 15:46
@msporny msporny requested review from dlongley and brentzundel and removed request for selfissued August 17, 2024 15:46
@msporny msporny added editorial Purely editorial changes to the specification. CR1 This item was processed during CR1 labels Aug 17, 2024
@msporny msporny merged commit 8cb3bcf into main Aug 17, 2024
1 check passed
@msporny msporny deleted the editorial-pass branch August 17, 2024 16:26
@msporny
Copy link
Member

msporny commented Aug 17, 2024

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=]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
An ecosystem where one [=verifiable credentials=]
An ecosystem where [=verifiable credentials=]

Comment on lines +270 to +275
[=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.
Copy link
Member

@TallTed TallTed Aug 19, 2024

Choose a reason for hiding this comment

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

Suggested change
[=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.

Comment on lines +306 to +311
[=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
Copy link
Member

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).

Suggested change
[=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

Comment on lines +317 to +321
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.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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.

Comment on lines +325 to 327
This specification standardizes a way of expressing [=credentials=] on the
Web, ensuring they are cryptographically secure, privacy-respecting, and
machine-verifiable.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
the classes of vehicle entitled to drive, or date of birth)
date of birth, or the classes of vehicle they're qualified to drive)

Comment on lines +378 to +380
Evidence demonstrating how the [=subject=] met the qualifications required
for issuing the [=credential=] (for example, a measurement, proof of
citizenship, or test result)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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)

Comment on lines 390 to 391
physical [=credential=] represents. The addition of technologies, such as
digital signatures, makes [=verifiable credentials=] more tamper-evident and
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
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
Copy link
Contributor Author

thanks @msporny !

@TallTed I'll incorporate your text into a follow up pr when i work on sections 8-9

@TallTed
Copy link
Member

TallTed commented Aug 19, 2024

@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.

@msporny
Copy link
Member

msporny commented Aug 19, 2024

@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.

decentralgabe pushed a commit that referenced this pull request Aug 26, 2024
msporny pushed a commit that referenced this pull request Sep 15, 2024
msporny pushed a commit that referenced this pull request Sep 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR1 This item was processed during CR1 editorial Purely editorial changes to the specification.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants