indieweb / indieweb/jf2

document solving Embedded Experiences goal from charter

Open
#36 0 comments 0 reactions 0 assignees View on GitHub
Needs Volunteer
Dominant language
HTML
Stars
12
Forks
4
PR merge metrics
No merged PRs in 30d

Description

I have successfully used use of webmention.io's jf2 output + streams.tmb jf2 input (and subsequent HTML5+mf2 output) to do RSVPs embedding on my event posts (see indieweb.org/event#Tantek and indieweb.org/RSVPs#Tantek for links to examples) which is definitely an Embedded Experience per the description in the Chaarter Goals: https://www.w3.org/2013/socialweb/social-wg-charter.html#goals

jf2 should have a section on "implementation classes" (similar to other specs) with subsections such as "API endpoint" (webmention.io would qualify), and perhaps "Embedding Service" (streams.tmb would qualify) that describe how a standard embedding service can be built by consuming jf2, and producing stylable and presentable HTML+mf2 for providing Embedded Experiences

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the JF2 specification and the linked Social Web charter goal, then review the webmention.io JF2 output and streams.tmb JF2 input examples cited in the issue. Done means the specification documents implementation classes, including the proposed API endpoint and embedding service examples, with the Embedded Experience use case explained.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.