search

t-mullen / realtime-collaboration-spec

A specification for programmer-oriented realtime collaboration.
13 stars 0 forks source link

Formatting and layout of document #4

Open t-mullen opened 6 years ago

t-mullen commented 6 years ago

Document is loosely based on the W3 Candidate documents. It could use some help.

I've used something close to WebIDL for the interfaces, because it's the only IDL I'm somewhat familiar with. If there is something more appropriate, I'd love to hear it.

Not sure if Markdown is the best way to write this.

t-mullen commented 6 years ago

Relevant document for specification of CRDTs.

https://github.com/FredKSchott/CoVim/files/1498121/Specification.And.Complexity.Of.Collaborative.Text.Editing.pdf

AGhost-7 commented 6 years ago

Maybe reStructured text could be nice. There are several features which could be useful for a document which would probably become quite complex.

t-mullen commented 6 years ago

I've never used RST, what do you like in it that Markdown doesn't have?

AGhost-7 commented 6 years ago

For one, includes. If you want to break down a large document into several files this could be useful. There's also some stuff like boxes which could draw attention to certain parts of the document.

t-mullen commented 6 years ago

That's definitely useful... agreed.