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

Improve README and start to decouple JSON #74

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve README and start to decouple JSON #74

wants to merge 2 commits into from

Conversation

kylef
Copy link
Member

@kylef kylef commented Jul 7, 2017

Starting #60.

NOTE: I've also added myself to Authors.

@kylef kylef requested a review from smizell July 7, 2017 14:31
@@ -51,8 +47,14 @@ Using Refract, we can expand this out and add some human-readable titles and des
{
Copy link
Member Author

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.

Copy link
Contributor

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

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.

Copy link
Contributor

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.

Copy link
Contributor

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.

@kylef kylef modified the milestone: Release 1.0.0 Jul 7, 2017
Copy link
Contributor

@smizell smizell left a 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]
Copy link
Contributor

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]
Copy link
Contributor

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
{
Copy link
Contributor

Choose a reason for hiding this comment

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

Sounds good to me.

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.

2 participants