From f547e5ed1f217eb3bf41a80a464d352066c01a8c Mon Sep 17 00:00:00 2001 From: kenclary Date: Mon, 22 Nov 2021 16:52:19 -0500 Subject: [PATCH] Create 0001-library-adr.rst Draft of ADR for repo. --- docs/decisions/0001-library-adr.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/decisions/0001-library-adr.rst diff --git a/docs/decisions/0001-library-adr.rst b/docs/decisions/0001-library-adr.rst new file mode 100644 index 000000000..911bda105 --- /dev/null +++ b/docs/decisions/0001-library-adr.rst @@ -0,0 +1,10 @@ +This library is meant for high-level components related to "content" types, which sometimes correspond to xblocks --- so videos, html, problems, etc. + - This is a higher-level layer on top of paragon. + +The components may be shared across multiple frontends. + - For example, components may be used by both the learning MFE, the course authoring MFE, and the shared content MFE. + - Video-playing components may be used for previewing in editing contexts, etc. + +The components cover many types of content, not just a single one. + - For example, HTML editing frontend might share code and style with video editing or problem editing. + - This will also help keep style and accessibility consistent across different content types.