SynBioDex / SBOL-specification

The Synthetic Biology Open Language (SBOL)
http://sbolstandard.org
13 stars 9 forks source link

Primary published version of 3.0.1 should not use redlines #441

Closed jakebeal closed 3 years ago

jakebeal commented 3 years ago

While our typical practice is to use redlines to identify specification changes, I believe that doing so for the SBOL 3.0.1 specification vs. the 3.0.0 specification will be more confusing than valuable.

Version 3.0.1 is the first "real" implemented version, and there are substantial differences with 3.0.0. The differences between 3.0.0 and 3.0.1, however, will only really be of interest to the very small community of alpha implementers who have been involved in the development of 3.0.1. Most people who encounter the SBOL 3 specification, however, will be more confused than enlightened by a description of our non-backward-compatible bug fixes in the 3.0.0 spec.

Thus, I would suggest that, even if we produce a redline version, it should not be the primary published version.

cjmyers commented 3 years ago

Redline version still use to save time during final review before "publication".

jakebeal commented 3 years ago

I'm fine with that, though I may suggest some areas be done as blocks rather than interlaced.

cjmyers commented 3 years ago

That's fine.

jakebeal commented 3 years ago

Accordingly, I propose that we just use redline generating LaTeX tools on the final .tex files rather than tracking it all through the document by hand. There's a lot of it, and I'm finding it very confusing at times.

cjmyers commented 3 years ago

Ok sounds good

jakebeal commented 3 years ago

I'd like to leave this open until the modifications are committed to the repo.