Skip to content

Commit

Permalink
docs: apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi authored Dec 6, 2024
1 parent 8fa418e commit 6fd6864
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/decisions/0017-generalized-containers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 2 additions & 3 deletions docs/decisions/0019-selectors.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Selectors for Dynamically Selecting Content
19. Selectors for Dynamically Selecting Content
===========================================

Context
Expand Down Expand Up @@ -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.
Expand All @@ -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

0 comments on commit 6fd6864

Please sign in to comment.