-
Notifications
You must be signed in to change notification settings - Fork 9
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
Improve README and start to decouple JSON #74
base: master
Are you sure you want to change the base?
Conversation
@@ -51,8 +47,14 @@ Using Refract, we can expand this out and add some human-readable titles and des | |||
{ |
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.
To be honest, I think JSON may be the best way to express this structure as it is very detailed and contains a lot of information. I've left it in JSON, especially since the future paragraphs talk about "JSON" in comparison to this structure.
I have updated the serialisation of the meta components to follow JSON serialisation rules.
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.
Sounds good to me.
} | ||
``` | ||
- name: John Doe | ||
- email: [email protected] |
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.
Perhaps it would make sense to keep this as JSON for consistency.
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.
Yeah, I think you're right. You could make the distinction that it's a JSON example.
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.
You may even link to the JSON serializarion rules.
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.
Looks good to me. I think keeping as JSON examples is a good idea and just add a note it's an example.
I approve but also know you want to change things so I'll pick request changes. That feels like an odd choice though :)
} | ||
``` | ||
- name: John Doe | ||
- email: [email protected] |
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.
Yeah, I think you're right. You could make the distinction that it's a JSON example.
} | ||
``` | ||
- name: John Doe | ||
- email: [email protected] |
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.
You may even link to the JSON serializarion rules.
@@ -51,8 +47,14 @@ Using Refract, we can expand this out and add some human-readable titles and des | |||
{ |
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.
Sounds good to me.
Starting #60.
NOTE: I've also added myself to Authors.