Write Document Structure

Problem

The structure of a hypermedia document is very confusing and poorly documented

Solution

Use SeedHypermedia to write a set of documents to explain how documents work.

What is the format of the permanent data

How can the permanent data be interpreted into a Document snapshot

How is the document snapshot presented to the user within a publication box

Scope

This could easily take weeks, but for now we could commit two days of effort, with @... and @... working together, and then review as a team.

Rabbit Holes

Will we document the way things work right now, or how we want them to work in the future? If we try to document the way things work right now, we have an incomplete picture. If we try to explain how things will work in the future, we will struggle with areas that we have not built consensus. If we try to do both, we make a big mess.

No Goes

We will avoid documenting the details of the p2p protocol, syncing, and interactions with http sites. The focus here is on Document structure

Activity