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

Restructure spec to describe basic concepts and verification #65

Merged
merged 11 commits into from
Aug 3, 2017

Conversation

msporny
Copy link
Member

@msporny msporny commented Jul 27, 2017

Per my action item from last week's call, I've restructured the spec to contain "basic concepts", "advanced concepts" and "verification" sections. Laying the specification out in this way enables us to neatly answer a number of the questions that @ChristopherA raised in #59.

This restructuring has also led to the ability to simplify the core data model section, which will be done in a separate PR. For the time being, ignore the Core Data Model section, and focus on the "Basic Concepts", "Advanced Concepts", and "Verification" sections in the spec. Don't worry about typos/prose for now, this PR is just to test out the new layout for the spec to see if it resonates with the group.

You can preview this PR here:

https://htmlpreview.github.io/?https://github.com/w3c/vc-data-model/blob/msporny-verification/index.html

/cc @ChristopherA @kimdhamilton

@dlongley
Copy link
Contributor

Manu and I discussed this before he reworked it, so +1 to this approach or something very similar.

The basic idea is to introduce the core data model parts first (essentially prerequisites for understanding anything at all). Then introduce individual elements of the data model that are related to different aspects of using verifiable claims (where each action/usage is a subsection). In each of these subsections we should mention at the end of the section that the data model terms introduced therein are related to verification in such and such ways with a link off to the verification section. Then, the verification section goes through, comprehensively, all of the various things that can be verified.

@ChristopherA
Copy link

+1

I like the direction this is going. I may quibble with some words and other minor items, like what to do in situations with multiple signature and/or timestamps, and there may be some revocation family of ideas that may have to be rethought, but these changes will move us in the direction of being able to address those issues.

@stonematt
Copy link
Contributor

i like this direction also - thanks manu.

@burnburn
Copy link
Contributor

burnburn commented Aug 1, 2017

Yes, this is a definite improvement.

@kimdhamilton
Copy link
Contributor

kimdhamilton commented Aug 1, 2017

LGTM

I prefer this approach because of the conceptual clarity it enables for all technical audiences. As an implementer, I personally don't anticipate being negatively impacted.

@msporny
Copy link
Member Author

msporny commented Aug 3, 2017

Thanks all, seeing no objections, merging now.

@msporny msporny merged commit 6b7814b into gh-pages Aug 3, 2017
@msporny msporny deleted the msporny-verification branch November 30, 2017 20:47
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.

6 participants