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

Add documentation on compatability with h-review #2

Open
capjamesg opened this issue Sep 9, 2020 · 1 comment
Open

Add documentation on compatability with h-review #2

capjamesg opened this issue Sep 9, 2020 · 1 comment

Comments

@capjamesg
Copy link
Member

capjamesg commented Sep 9, 2020

The h-feed wiki page is unclear on its compatibility with h-review.

In the "Properties" section, the only guidance given for children is:

nested h-entry objects representing the items of the feed

Given how a h-review could be a child of a h-feed item, I recommend that we add it to the list of children.

The use case for a h-review in a h-feed is creating a marked-up list of reviews. For instance, I am building a feed of all the coffees I consume that is marked up using mf2.

In the section on "Properties", the h-review page does say:

Several of these seem to be because of h-review convergence towards h-entry, as h-review gets used alongside h-entry within h-feed:

The wording here is somewhat unclear. Are h-reviews to be used in the same feed as a h-entry? Or as part of a h-entry? Or something else?

@dshanske
Copy link
Member

Related #3

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

No branches or pull requests

2 participants