From 6fd68643ea3753b3ebe034b8db4fb2aa3a016b88 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Fri, 6 Dec 2024 12:22:35 +0100 Subject: [PATCH] docs: apply suggestions from code review --- docs/decisions/0017-generalized-containers.rst | 2 +- docs/decisions/0019-selectors.rst | 5 ++--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/decisions/0017-generalized-containers.rst b/docs/decisions/0017-generalized-containers.rst index 944e1b38..4e50af59 100644 --- a/docs/decisions/0017-generalized-containers.rst +++ b/docs/decisions/0017-generalized-containers.rst @@ -40,7 +40,7 @@ This section defines container types, content constraints, hierarchy, and extens This section defines container children, their order, and relationships, covering flexible connections and support for draft and published states of their children. - Each container version holds a list of children that the author has defined for that version. -- The author-defined list is used to show the content of a container version as the author specified it +- The author-defined list is used to show the content of a container version as the author specified it. - The author-defined list won't change for a specific container version even if its members change. E.g., a unit version UV1 with three components (CV1, CV2, CV3) will always have those three components in the author-defined list, even if one of the components is soft-deleted or a new version for the component is created. - The children of a container can be any type of publishable content. E.g., sections, subsections, units, components, and any other publishable thing. For more details on publishable content, see `PublishableEntity`_. - Children within a container are maintained in a specific order as an ordered list. E.g., components within a unit, or units within a subsection, are presented in a specific order. diff --git a/docs/decisions/0019-selectors.rst b/docs/decisions/0019-selectors.rst index 066835ee..09fcb816 100644 --- a/docs/decisions/0019-selectors.rst +++ b/docs/decisions/0019-selectors.rst @@ -1,4 +1,4 @@ -Selectors for Dynamically Selecting Content +19. Selectors for Dynamically Selecting Content =========================================== Context @@ -27,7 +27,7 @@ This section explains the concepts and behaviors used to build dynamic selection This section describes how different types of selectors work and how they handle the selection of dynamic content. -- A selector can be of any type, which means it can implement any method to select members from a pool. Therefore, selectors will follow extensibility principles in `0003-content-extensibility.rst`_ for creating new selector types. +- A selector can be of any type, which means it can implement any method to select members from a pool. Therefore, selectors will follow extensibility principles in `0003-content-extensibility.rst <0003-content-extensibility.rst>`_ for creating new selector types. - Selection versions encode the rules and holds useful details for the selection process like: where to get members from, number of items to select, and other criteria. For instance, for the "select 5 components out of this pool of 20 components" its selector version would encode where to get the 20 components, how many to get for each user and any other detail needed to create the specific variants. - Depending on the size of the pool of members, variants can be generated at publishing time or on-demand. This behavior should be determined by the selector version based on high vs low permutation scenarios. - A compositor is responsible for populating the variants but will not be implemented as part of the selector application which belongs to the authoring app. @@ -37,4 +37,3 @@ This section describes how different types of selectors work and how they handle A new version of a selector is created whenever the pool of concent changes by adding, removing or reordering existing members. -.. _0003-content-extensibility.rst: docs/decisions/0003-content-extensibility.rst